From 85e3e38b3847f533febf2c497d788c30940caed7 Mon Sep 17 00:00:00 2001 From: cortex-sg <125449181+cortex-sg@users.noreply.github.com> Date: Mon, 18 Mar 2024 10:59:44 +0000 Subject: [PATCH] Improved some more data types documentation --- .../data-types/collections/ireadonlylist-1.md | 63 ++++++++++- .../data-types/credentials/usercredentials.md | 2 +- .../date-and-time/datetimecomponenttype.md | 75 +++++++------ .../data-types/date-and-time/timeperiod.md | 49 +++++--- .../data-types/date-and-time/timespan.md | 39 ++++++- .../data-types/exceptions/exception.md | 39 ++++++- .../oauth/gmailoauthcertificatecredentials.md | 2 +- .../oauth/clientauthentication.md | 40 +++++++ .../oauth/httpoauthclientcredentials.md | 42 +++++++ .../oauth/httpoauthpasswordcredentials.md | 89 ++++++++++++--- .../data-types/http/httprequestversion.md | 40 ++++--- .../data-types/http/httpstatuscode.md | 80 +++++++++++++ .../Reference/data-types/http/requestverb.md | 66 ++++++++--- .../data-types/http/rest/httprequest.md | 105 +++++++++++++++--- .../data-types/http/rest/httpresponse.md | 74 ++++++++++-- .../data-types/http/soap/soap11message.md | 48 ++++++++ .../data-types/http/soap/soapmessage.md | 32 ++++++ .../data-types/http/soap/soaprequest.md | 60 +++++++++- .../data-types/http/soap/soapresponse.md | 53 ++++++++- ...microsoft365oauthcertificatecredentials.md | 59 +++++++++- .../oauth/microsoft365oauthcredentials.md | 47 +++++++- .../2024.1/Reference/data-types/text/char.md | 1 + .../Reference/data-types/text/cultureinfo.md | 96 ++++++++++++++-- .../Reference/data-types/text/encoding.md | 44 +++++++- .../data-types/text/encryptabletext.md | 40 ++++++- .../data-types/text/encryptedtext.md | 40 ++++++- .../data-types/text/iformatprovider.md | 42 ++++++- .../Reference/data-types/text/regex/_index.md | 2 +- .../Reference/data-types/text/regex/match.md | 3 - .../data-types/text/searchoptions.md | 1 + .../Reference/data-types/text/string.md | 1 + .../data-types/text/stringcomparer.md | 1 + .../data-types/text/stringcomparison.md | 55 ++++++++- .../data-types/text/stringsplitoptions.md | 1 + .../data-types/text/textdecodingerrorcode.md | 1 + .../data-types/text/textencodingformat.md | 1 + .../Reference/data-types/text/texttofind.md | 1 + .../data-types/text/unicodeencoding.md | 41 ++++++- .../data-types/text/utf32encoding.md | 41 ++++++- .../Reference/data-types/text/utf8encoding.md | 41 ++++++- data/urls.toml | 14 +++ 41 files changed, 1382 insertions(+), 189 deletions(-) create mode 100644 content/en/docs/2024.1/Reference/data-types/http/httpstatuscode.md diff --git a/content/en/docs/2024.1/Reference/data-types/collections/ireadonlylist-1.md b/content/en/docs/2024.1/Reference/data-types/collections/ireadonlylist-1.md index fc05b4734..bab3b34f0 100644 --- a/content/en/docs/2024.1/Reference/data-types/collections/ireadonlylist-1.md +++ b/content/en/docs/2024.1/Reference/data-types/collections/ireadonlylist-1.md @@ -1,7 +1,66 @@ --- title: "IReadOnlyList" linkTitle: "IReadOnlyList" -description: "" +description: "Any data type representing a list of items that can iterated or looped over, where the number and order of items is read-only. `TItem` indicates the data type of the items contained in the list. Each `TItem` can be individually accessed by an index." --- +# {{% param title %}} -{{}} \ No newline at end of file +

(System.Collections.Generic.IReadOnlyList<TItem>)

+ +## Summary + +Any data type representing a list of items that can iterated or looped over, where the number and order of items is read-only. + +`TItem` indicates the data type of the items contained in the list. Each `TItem` can be individually accessed by an index. + +| | | +|-|-| +| **Category:** | Collections | +| **Name:** | `IReadOnlyList` | +| **Full Name:** | `System.Collections.Generic.IReadOnlyList` | +| **Alias:** | N/A | +| **Description:** | Any data type representing a list of items that can iterated or looped over, where the number and order of items is read-only. `TItem` indicates the data type of the items contained in the list. Each `TItem` can be individually accessed by an index. | +| **Default Value:** | `null` | +| **Can be used as:** | `IReadOnlyList`, `IReadOnlyCollection`, `IEnumerable`, `IEnumerable`, `Object`, `dynamic` | +| | `IEnumerable` (e.g. where `IReadOnlyList` is `IReadOnlyList` and `IEnumerable` is `IEnumerable` as `Object` is a base type of `Int32`; this is called covariance) | +| **Can be cast to:** | N/A | + +### Property Editor Support + +* The Expression Editor is available for [Input][] properties where the data type is `IReadOnlyList`. +* The Literal Editor is not available for [Input][] properties where the data type is `IReadOnlyList`. +* The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `IReadOnlyList`. + +### Known Limitations + +None + +## See Also + +### Related Data Types + +* [IEnumerable][] +* [IEnumerable<TItem>][] +* [List<TItem>][] + +### Related Concepts + +* [Working with Collections][] + +### External Documentation + +* [System.Collections.Generic.IReadOnlyList<TItem>][] +* [System.Collections.Generic.IReadOnlyCollection<TItem>][] + +[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} +[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} +[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} + +[System.Collections.Generic.IReadOnlyList<TItem>]: {{< url path="MSDocs.DotNet.Api.System.Collections.Generic.IReadOnlyList" >}} +[System.Collections.Generic.IReadOnlyCollection<TItem>]: {{< url path="MSDocs.DotNet.Api.System.Collections.Generic.IReadOnlyCollection" >}} + +[IEnumerable]: {{< url path="Cortex.Reference.DataTypes.Collections.IEnumerable.MainDoc" >}} +[IEnumerable<TItem>]: {{< url path="Cortex.Reference.DataTypes.Collections.IEnumerable_TItem.MainDoc" >}} +[List<TItem>]: {{< url path="Cortex.Reference.DataTypes.Collections.List.MainDoc" >}} + +[Working with Collections]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Collections.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/credentials/usercredentials.md b/content/en/docs/2024.1/Reference/data-types/credentials/usercredentials.md index 4c00752b4..9c2103e4d 100644 --- a/content/en/docs/2024.1/Reference/data-types/credentials/usercredentials.md +++ b/content/en/docs/2024.1/Reference/data-types/credentials/usercredentials.md @@ -19,7 +19,7 @@ The `UserCredentials` data type is used to represent details required to authent | **Full Name:** | `Cortex.DataTypes.Credentials.UserCredentials` | | **Alias:** | N/A | | **Description:** | Details required to authenticate with a domain or server. | -| **Default Value:** | `null` | +| **Default Value:** | `null` | | **Can be used as:** | `EmailUserCredentials`, `EmailCredentials`, `IEmailCredentials`, `HttpUserCredentials`, `HttpCredentials`, `IHttpCredentials`, `SshUserCredentials`, `SshCredentials`, `ISshCredentials`, `UserCredentials`, `IUserCredentials`, `NetworkCredential`, `Object`, `dynamic` | | **Can be cast to:** | N/A | diff --git a/content/en/docs/2024.1/Reference/data-types/date-and-time/datetimecomponenttype.md b/content/en/docs/2024.1/Reference/data-types/date-and-time/datetimecomponenttype.md index 04d020197..355ac96d6 100644 --- a/content/en/docs/2024.1/Reference/data-types/date-and-time/datetimecomponenttype.md +++ b/content/en/docs/2024.1/Reference/data-types/date-and-time/datetimecomponenttype.md @@ -8,54 +8,67 @@ description: "Used to represent a component of a `DateTimeOffset` (e.g. `Year`,

(Cortex.DataTypes.DateAndTime.DateTimeComponentType)

-{{< workinprogress >}} +{{% alert type="information" title="Information" %}} Improvements to this page are planned for the future. {{% /alert %}} ## Summary -## Values +The `DateTimeComponentType` data type is used to represent a component of a `DateTimeOffset` (e.g. `Year`, `Month`, `Day`). + +`DateTimeComponentType` is an [enum][Working with Enums] data type, which means it has a defined set of values, where each value has an associated [String][] name and [Int32][] value. + +| | | +|-|-| +| **Category:** | Date & Time | +| **Name:** | `DateTimeComponentType` | +| **Full Name:** | `Cortex.DataTypes.DateAndTime.DateTimeComponentType` | +| **Alias:** | N/A | +| **Description:** | Used to represent a component of a `DateTimeOffset` (e.g. `Year`, `Month`, `Day`). | +| **Default Value:** | `(DateTimeComponentType)0` | +| **Can be used as:** | `DateTimeComponentType`, `object`, `dynamic` | +| **Can be cast to:** | `Int16` (e.g. `(Int16)DateTimeComponentType.LocalDateTime` or `(System.Int16)DateTimeComponentType.LocalDateTime` or `(short)DateTimeComponentType.LocalDateTime`) | +| | `Int32` (e.g. `(Int32)DateTimeComponentType.LocalDateTime` or `(System.Int32)DateTimeComponentType.LocalDateTime` or `(int)DateTimeComponentType.LocalDateTime`) | +| | `Int64` (e.g. `(Int64)DateTimeComponentType.LocalDateTime` or `(System.Int64)DateTimeComponentType.LocalDateTime` or `(long)DateTimeComponentType.LocalDateTime`) | +| | `Single` (e.g. `(Single)DateTimeComponentType.LocalDateTime` or `(System.Single)DateTimeComponentType.LocalDateTime` or `(float)DateTimeComponentType.LocalDateTime`) | +| | `Double` (e.g. `(Double)DateTimeComponentType.LocalDateTime` or `(System.Double)DateTimeComponentType.LocalDateTime` or `(double)DateTimeComponentType.LocalDateTime`) | -### LocalDateTime - -### UtcDateTime - -### Date - -### Time - -### Year - -### Month - -### Day +## Remarks -### Hour +### Property Editor Support -### Minute +- The Expression Editor is available for [Input][] properties where the data type is `DateTimeComponentType`. +- The Literal Editor is available for [Input][] properties where the data type is `DateTimeComponentType`. +- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `DateTimeComponentType`. -### Second +### Known Limitations -### Millisecond +None -### Offset +## See Also -### DayOfYear +### Related Data Types -### DayOfWeek +- [DateTimeOffset][] -## Remarks +### Related Concepts -### Create a DateTimeComponentType +- [Working with Date and Time][] -### Convert DateTimeComponentType to Text +### External Documentation -### Property Editor Support +- [System.DateTimeOffset][] +- [System.Enum][] -### Known Limitations +[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} +[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} +[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} -## See Also +[DateTimeOffset]: {{< url path="Cortex.Reference.DataTypes.DateAndTime.DateTimeOffset.MainDoc" >}} -### Related Data Types +[Working with Date and Time]: {{< url path="Cortex.Reference.Concepts.WorkingWith.DateAndTime.MainDoc" >}} +[System.DateTimeOffset]: {{< url path="MSDocs.DotNet.Api.System.DateTimeOffset.MainDoc" >}} -### Related Concepts +[System.Enum]: {{< url path="MSDocs.DotNet.Api.System.Enum.MainDoc" >}} -### External Documentation +[Working with Enums]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Enums.MainDoc" >}} +[String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}} +[Int32]: {{< url path="Cortex.Reference.DataTypes.Numbers.Int32.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/date-and-time/timeperiod.md b/content/en/docs/2024.1/Reference/data-types/date-and-time/timeperiod.md index 525efaca2..a2de619fd 100644 --- a/content/en/docs/2024.1/Reference/data-types/date-and-time/timeperiod.md +++ b/content/en/docs/2024.1/Reference/data-types/date-and-time/timeperiod.md @@ -8,40 +8,53 @@ description: "Used to represent a time interval (duration of time or elapsed tim

(Cortex.DataTypes.DateAndTime.TimePeriod)

-{{< workinprogress >}} +{{% alert type="information" title="Information" %}} Improvements to this page are planned for the future. {{% /alert %}} ## Summary -## Properties +The `TimePeriod` datatype is used to represent a time interval (duration of time or elapsed time) that is measured as a positive or negative number of `years`, `months`, `days`, `hours`, `minutes`, `seconds`, and `milliseconds`. -### Years +| | | +|-|-| +| **Category:** | Date & Time | +| **Name:** | `TimePeriod` | +| **Full Name:** | `Cortex.DataTypes.DateAndTime.TimePeriod` | +| **Alias:** | N/A | +| **Description:** | Used to represent a time interval that is measured as a positive or negative number of `years`, `months`, `days`, `hours`, `minutes`, `seconds`, and `milliseconds`. | +| **Default Value:** | `null` | +| **Can be used as:** | `TimePeriod`, `object`, `dynamic` | +| **Can be cast to:** | N/A | -### Months +## Remarks -### Days +### Property Editor Support -### Hours +- The Expression Editor is available for [Input][] properties where the data type is `TimePeriod`. +- The Literal Editor is available for [Input][] properties where the data type is `TimePeriod`. +- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `TimePeriod`. -### Minutes +### Known Limitations -### Seconds +None -### Milliseconds +## See Also -## Remarks +### Related Data Types -### Create a TimePeriod +- [TimeSpan] -### Convert TimePeriod to Text +### Related Concepts -### Property Editor Support +- [Working with Date and Time][] -### Known Limitations +### External Documentation -## See Also +None -### Related Data Types +[Working with Date and Time]: {{< url path="Cortex.Reference.Concepts.WorkingWith.DateAndTime.MainDoc" >}} -### Related Concepts +[TimeSpan]: {{< url path="Cortex.Reference.DataTypes.DateAndTime.TimeSpan.MainDoc" >}} -### External Documentation +[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} +[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} +[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/date-and-time/timespan.md b/content/en/docs/2024.1/Reference/data-types/date-and-time/timespan.md index cd53b68b1..5c0d0abc6 100644 --- a/content/en/docs/2024.1/Reference/data-types/date-and-time/timespan.md +++ b/content/en/docs/2024.1/Reference/data-types/date-and-time/timespan.md @@ -8,24 +8,55 @@ description: "Used to represent a time interval (duration of time or elapsed tim

(System.TimeSpan)

-{{< workinprogress >}} +{{% alert type="information" title="Information" %}} Improvements to this page are planned for the future. {{% /alert %}} ## Summary -## Remarks +Used to represent a time interval (duration of time or elapsed time) that is measured as a positive or negative number of `days`, `hours`, `minutes`, `seconds`, and `milliseconds`. It can be used wherever a `TimePeriod` is expected, and wll be converted to a `TimePeriod` automatically. -### Create a TimeSpan +| | | +|-|-| +| **Category:** | Date & Time | +| **Name:** | `TimeSpan` | +| **Full Name:** | `System.TimeSpan` | +| **Alias:** | N/A | +| **Description:** | Used to represent a time interval (duration of time or elapsed time) that is measured as a positive or negative number of `days`, `hours`, `minutes`, `seconds`, and `milliseconds`. It can be used wherever a `TimePeriod` is expected, and wll be converted to a `TimePeriod` automatically. | +| **Default Value:** | `new TimeSpan(0, 0, 0, 0, 0)` | +| **Can be used as:** | `TimeSpan`, `TimePeriod`, `object`, `dynamic` | +| **Can be cast to:** | N/A | -### Convert TimeSpan to Text +## Remarks ### Property Editor Support +- The Expression Editor is available for [Input][] properties where the data type is `TimeSpan`. +- The Literal Editor is available for [Input][] properties where the data type is `TimeSpan`. +- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `TimeSpan`. + ### Known Limitations +None + ## See Also ### Related Data Types +- [TimePeriod][] + ### Related Concepts +- [Working with Date and Time][] + ### External Documentation + +- [System.TimeSpan][] + +[Working with Date and Time]: {{< url path="Cortex.Reference.Concepts.WorkingWith.DateAndTime.MainDoc" >}} + +[TimePeriod]: {{< url path="Cortex.Reference.DataTypes.DateAndTime.TimePeriod.MainDoc" >}} + +[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} +[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} +[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} + +[System.TimeSpan]: {{< url path="MSDocs.DotNet.Api.System.TimeSpan.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/exceptions/exception.md b/content/en/docs/2024.1/Reference/data-types/exceptions/exception.md index 2f349b576..d441b009e 100644 --- a/content/en/docs/2024.1/Reference/data-types/exceptions/exception.md +++ b/content/en/docs/2024.1/Reference/data-types/exceptions/exception.md @@ -1,31 +1,60 @@ --- title: "Exception" linkTitle: "Exception" -description: "The data type that all exceptions inherit from." +description: "Any data type used to represent an exception." --- # {{% param title %}}

(System.Exception)

-{{< workinprogress >}} +{{% alert type="information" title="Information" %}} Improvements to this page are planned for the future. {{% /alert %}} ## Summary -## Remarks +Any data type used to represent an exception. -### Create an Exception +| | | +|-|-| +| **Category:** | Exception | +| **Name:** | `Exception` | +| **Full Name:** | `System.Exception` | +| **Alias:** | N/A | +| **Description:** | Any data type used to represent an exception. | +| **Default Value:** | `null` | +| **Can be used as:** | `Exception`, `object`, `dynamic` | +| **Can be cast to:** | N/A | -### Convert Exception to Text +## Remarks ### Property Editor Support +- The Expression Editor is available for [Input][] properties where the data type is `Exception`. +- The Literal Editor is available for [Input][] properties where the data type is `Exception`. +- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `Exception`. + ### Known Limitations +None + ## See Also ### Related Data Types +None + ### Related Concepts +- [Exceptions][] + ### External Documentation + +- [System.Exception] + +[Exceptions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Exceptions.MainDoc" >}} + +[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} +[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} +[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} + +[System.Exception]: {{< url path="MSDocs.DotNet.Api.System.Exception" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/google-workspace/gmail/authentication/oauth/gmailoauthcertificatecredentials.md b/content/en/docs/2024.1/Reference/data-types/google-workspace/gmail/authentication/oauth/gmailoauthcertificatecredentials.md index 705c56476..602f25759 100644 --- a/content/en/docs/2024.1/Reference/data-types/google-workspace/gmail/authentication/oauth/gmailoauthcertificatecredentials.md +++ b/content/en/docs/2024.1/Reference/data-types/google-workspace/gmail/authentication/oauth/gmailoauthcertificatecredentials.md @@ -61,7 +61,7 @@ The FromAddress is used to define the address of the account used to set up the ### ClientId -The ClientId is used to define client ID of the client application created to allow authentication via OAuth. The value of this property may optionally be encrypted; for more information on how to encrypt this property, see [EncryptableText][]. +The ClientId is used to define the client ID of the client application created to allow authentication via OAuth. The value of this property may optionally be encrypted; for more information on how to encrypt this property, see [EncryptableText][]. | | | |--------------------|---------------------------| diff --git a/content/en/docs/2024.1/Reference/data-types/http/authentication/oauth/clientauthentication.md b/content/en/docs/2024.1/Reference/data-types/http/authentication/oauth/clientauthentication.md index eb6cd70d0..2720cd459 100644 --- a/content/en/docs/2024.1/Reference/data-types/http/authentication/oauth/clientauthentication.md +++ b/content/en/docs/2024.1/Reference/data-types/http/authentication/oauth/clientauthentication.md @@ -30,10 +30,36 @@ The `ClientAuthentication` data type is used to represent the `ClientId` and `Cl ### ClientId +The ClientId is used to define the client ID assigned to {{% ctx %}} by the OAuth provider, to allow it to authenticate. The value of this property may optionally be encrypted; for more information on how to encrypt this property, see [EncryptableText][]. +| | | +|--------------------|---------------------------| +| Data Type | [EncryptableText][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [EncryptableText][] with value `""` | + ### ClientSecret +The ClientSecret is used to define the client secret assigned to {{% ctx %}} by the OAuth provider, to allow it to authenticate; this value should be kept secret. This property is an [EncryptedText][] and so it must be encrypted; for more information on how to encrypt the password, see [EncryptedText][]. + +| | | +|--------------------|---------------------------| +| Data Type | [EncryptedText][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [EncryptedText][] with value `""` | + ### SendAs +The SendAs is used to specify whether the [ClientId][] and [ClientSecret][] are included as part of the HTTP request body or headers. + +| | | +|--------------------|---------------------------| +| Data Type | [ClientAuthType][] | +| Is [Advanced][] | `true` | +| Default Editor | [Literal][] | +| Default Value | `Header` | + ## Remarks ### Property Editor Support @@ -50,6 +76,9 @@ None ### Related Data Types +- [ClientAuthType][] +- [EncryptableText][] +- [EncryptedText][] - [HttpOAuthClientCredentials][] - [HttpOAuthPasswordCredentials][] @@ -61,9 +90,20 @@ None None +[ClientId]: {{< ref "#clientid">}} +[Clientsecret]: {{< ref "#clientsecret">}} + [Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} [Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} [InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} [HttpOAuthClientCredentials]: {{< url path="Cortex.Reference.DataTypes.Http.Authentication.OAuth.HttpOAuthClientCredentials.MainDoc" >}} [HttpOAuthPasswordCredentials]: {{< url path="Cortex.Reference.DataTypes.Http.Authentication.OAuth.HttpOAuthPasswordCredentials.MainDoc" >}} +[Advanced]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.AdvancedProperties.MainDoc" >}} + +[Literal]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.LiteralEditor.MainDoc" >}} +[Expression]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.MainDoc" >}} + +[EncryptableText]: {{< url path="Cortex.Reference.DataTypes.Text.EncryptableText.MainDoc" >}} +[EncryptedText]: {{< url path="Cortex.Reference.DataTypes.Text.EncryptedText.MainDoc" >}} +[ClientAuthType]: {{< url path = "Cortex.Reference.DataTypes.Http.Authentication.OAuth.ClientAuthType.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/http/authentication/oauth/httpoauthclientcredentials.md b/content/en/docs/2024.1/Reference/data-types/http/authentication/oauth/httpoauthclientcredentials.md index 282ae5362..558b317ac 100644 --- a/content/en/docs/2024.1/Reference/data-types/http/authentication/oauth/httpoauthclientcredentials.md +++ b/content/en/docs/2024.1/Reference/data-types/http/authentication/oauth/httpoauthclientcredentials.md @@ -30,10 +30,37 @@ The `HttpOAuthClientCredentials` data type is used to represent details required ### AccessTokenUri +The AccessTokenUri represents the URI used to get the access token. The value of this property may optionally be encrypted; for more information on how to encrypt this property, see [EncryptableText][]. + +| | | +|-----------------|---------------------| +| Data Type | [EncryptableText][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [EncryptableText][] with value `$@""` | + ### ClientAuthentication +The ClientAuthentication represents the [ClientId][], [ClientSecret][] and [SendAs][]. + +| | | +|-----------------|--------------------------| +| Data Type | [ClientAuthentication][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [ClientAuthentication][] with no value | + ### Scope +The scope of permissions being requested for the access token. For multiple scopes, each scope should be separated by a space (e.g. `"Scope1 Scope2"`). + +| | | +|-----------------|-------------| +| Data Type | [String][] | +| Is [Advanced][] | `true` | +| Default Editor | [Literal][] | +| Default Value | [String][] with value `""` | + ## Remarks ### Property Editor Support @@ -50,10 +77,13 @@ None ### Related Data Types +- [ClientAuthentication][] +- [EncryptableText][] - [HttpCredentials][] - [HttpOAuthCredentials][] - [HttpOAuthPasswordCredentials][] - [IHttpCredentials][] +- [String][] ### Related Concepts @@ -71,3 +101,15 @@ None [HttpCredentials]: {{< url path="Cortex.Reference.DataTypes.Http.Authentication.HttpCredentials.MainDoc" >}} [HttpOAuthCredentials]: {{< url path="Cortex.Reference.DataTypes.Http.Authentication.OAuth.HttpOAuthCredentials.MainDoc" >}} [HttpOAuthPasswordCredentials]: {{< url path="Cortex.Reference.DataTypes.Http.Authentication.OAuth.HttpOAuthPasswordCredentials.MainDoc" >}} + +[Advanced]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.AdvancedProperties.MainDoc" >}} +[Literal]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.LiteralEditor.MainDoc" >}} +[Expression]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.MainDoc" >}} + +[EncryptableText]: {{< url path="Cortex.Reference.DataTypes.Text.EncryptableText.MainDoc" >}} +[ClientAuthentication]: {{< url path = "Cortex.Reference.DataTypes.Http.Authentication.OAuth.ClientAuthentication.MainDoc" >}} +[String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}} + +[ClientId]: {{< url path = "Cortex.Reference.DataTypes.Http.Authentication.OAuth.ClientAuthentication.ClientId" >}} +[ClientSecret]: {{< url path = "Cortex.Reference.DataTypes.Http.Authentication.OAuth.ClientAuthentication.ClientSecret" >}} +[SendAs]: {{< url path = "Cortex.Reference.DataTypes.Http.Authentication.OAuth.ClientAuthentication.SendAs" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/http/authentication/oauth/httpoauthpasswordcredentials.md b/content/en/docs/2024.1/Reference/data-types/http/authentication/oauth/httpoauthpasswordcredentials.md index cde884162..6692a199c 100644 --- a/content/en/docs/2024.1/Reference/data-types/http/authentication/oauth/httpoauthpasswordcredentials.md +++ b/content/en/docs/2024.1/Reference/data-types/http/authentication/oauth/httpoauthpasswordcredentials.md @@ -15,29 +15,74 @@ weight: 1 The `HttpOAuthPasswordCredentials` data type is used to represent details required for the OAuth Resource Owner Password Credentials authentication mechanism. -| | | -|-|-| -| **Category:** | Http | -| **Name:** | `HttpOAuthPasswordCredentials` | -| **Full Name:** | `Cortex.DataTypes.Http.Authentication.OAuth.HttpOAuthPasswordCredentials` | -| **Alias:** | N/A | -| **Description:** | Used to represent details required for the OAuth Resource Owner Password Credentials authentication mechanism. | -| **Default Value:** | `null` | -| **Can be used as:** | `HttpOAuthPasswordCredentials`, `HttpCredentials`, `IHttpCredentials`, `Object`, `dynamic` | -| **Can be cast to:** | N/A | +| | | +|---------------------|----------------------------------------------------------------------------------------------------------------| +| **Category:** | Http | +| **Name:** | `HttpOAuthPasswordCredentials` | +| **Full Name:** | `Cortex.DataTypes.Http.Authentication.OAuth.HttpOAuthPasswordCredentials` | +| **Alias:** | N/A | +| **Description:** | Used to represent details required for the OAuth Resource Owner Password Credentials authentication mechanism. | +| **Default Value:** | `null` | +| **Can be used as:** | `HttpOAuthPasswordCredentials`, `HttpCredentials`, `IHttpCredentials`, `Object`, `dynamic` | +| **Can be cast to:** | N/A | ## Properties -### ResourceOwnerUsername +### AccessTokenUri -### ResourceOwnerPassword +The AccessTokenUri represents the URI used to get the access token. The value of this property may optionally be encrypted; for more information on how to encrypt this property, see [EncryptableText][]. -### AccessTokenUri +| | | +|-----------------|-------------------------------------| +| Data Type | [EncryptableText][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [EncryptableText] with value `$@""` | ### ClientAuthentication +The ClientAuthentication represents the [ClientId][], [ClientSecret][] and [SendAs][]. + +| | | +|-----------------|--------------------------------------| +| Data Type | [ClientAuthentication][] | +| Is [Advanced][] | `true` | +| Default Editor | [Expression][] | +| Default Value | [ClientAuthentication] with no value | + ### Scope +The scope of permissions being requested for the access token. For multiple scopes, each scope should be separated by a space (e.g. `"Scope1 Scope2"`). + +| | | +|-----------------|----------------------------| +| Data Type | [String][] | +| Is [Advanced][] | `false` | +| Default Editor | [Literal][] | +| Default Value | [String][] with value `""` | + +### ResourceOwnerUsername + +The ResourceOwnerUsername is the username used to get the access token. The value of this property may optionally be encrypted; for more information on how to encrypt this property, see [EncryptableText][]. + +| | | +|-----------------|-------------------------------------| +| Data Type | [EncryptableText][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [EncryptableText][] with value `""` | + +### ResourceOwnerPassword + +The ResourceOwnerPassword is the password associated with the [ResourceOwnerUsername][]. This property is an [EncryptedText][] and so it must be encrypted; for more information on how to encrypt the password, see [EncryptedText][]. + +| | | +|-----------------|-----------------------------------| +| Data Type | [EncryptedText][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [EncryptedText][] with value `""` | + ## Remarks ### Property Editor Support @@ -54,10 +99,14 @@ None ### Related Data Types +- [ClientAuthentication][] +- [EncryptableText][] +- [EncryptedText][] - [HttpCredentials][] - [HttpOAuthClientCredentials][] - [HttpOAuthCredentials][] - [IHttpCredentials][] +- [String][] ### Related Concepts @@ -67,6 +116,8 @@ None None +[ResourceOwnerUsername]: {{< ref "#resourceownerusername">}} + [Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} [Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} [InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} @@ -75,3 +126,15 @@ None [HttpCredentials]: {{< url path="Cortex.Reference.DataTypes.Http.Authentication.HttpCredentials.MainDoc" >}} [HttpOAuthCredentials]: {{< url path="Cortex.Reference.DataTypes.Http.Authentication.OAuth.HttpOAuthCredentials.MainDoc" >}} [HttpOAuthClientCredentials]: {{< url path="Cortex.Reference.DataTypes.Http.Authentication.OAuth.HttpOAuthClientCredentials.MainDoc" >}} + +[Advanced]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.AdvancedProperties.MainDoc" >}} +[Literal]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.LiteralEditor.MainDoc" >}} +[Expression]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.MainDoc" >}} + +[EncryptableText]: {{< url path="Cortex.Reference.DataTypes.Text.EncryptableText.MainDoc" >}} +[EncryptedText]: {{< url path="Cortex.Reference.DataTypes.Text.EncryptedText.MainDoc" >}} +[ClientAuthentication]: {{< url path = "Cortex.Reference.DataTypes.Http.Authentication.OAuth.ClientAuthentication.MainDoc" >}} +[ClientId]: {{< url path = "Cortex.Reference.DataTypes.Http.Authentication.OAuth.ClientAuthentication.ClientId" >}} +[ClientSecret]: {{< url path = "Cortex.Reference.DataTypes.Http.Authentication.OAuth.ClientAuthentication.ClientSecret" >}} +[SendAs]: {{< url path = "Cortex.Reference.DataTypes.Http.Authentication.OAuth.ClientAuthentication.SendAs" >}} +[String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/http/httprequestversion.md b/content/en/docs/2024.1/Reference/data-types/http/httprequestversion.md index ff53c5ca5..903447eec 100644 --- a/content/en/docs/2024.1/Reference/data-types/http/httprequestversion.md +++ b/content/en/docs/2024.1/Reference/data-types/http/httprequestversion.md @@ -17,27 +17,39 @@ The `HttpRequestVersion` data type is used to represent the version of HTTP to b `HttpRequestVersion` is an [enum][Working with Enums] data type, which means it has a defined set of values, where each value has an associated [String][] name and [Int32][] value. -| | | -|-|-| -| **Category:** | Http | -| **Name:** | `HttpRequestVersion` | -| **Full Name:** | `Cortex.DataTypes.Http.HttpRequestVersion` | -| **Alias:** | N/A | -| **Description:** | Used to represent the version of HTTP to be used when making an HTTP request. | -| **Default Value:** | `(HttpRequestVersion)0` | -| **Can be used as:** | `HttpRequestVersion`, `Object`, `dynamic` | -| **Can be cast to:** | `Int16` (e.g. `(Int16)HttpRequestVersion.HTTP10` or `(System.Int16)HttpRequestVersion.HTTP10` or `(short)HttpRequestVersion.HTTP10`) | -| | `Int32` (e.g. `(Int32)HttpRequestVersion.HTTP10` or `(System.Int32)HttpRequestVersion.HTTP10` or `(int)HttpRequestVersion.HTTP10`) | -| | `Int64` (e.g. `(Int64)HttpRequestVersion.HTTP10` or `(System.Int64)HttpRequestVersion.HTTP10` or `(long)HttpRequestVersion.HTTP10`) | -| | `Single` (e.g. `(Single)HttpRequestVersion.HTTP10` or `(System.Single)HttpRequestVersion.HTTP10` or `(float)HttpRequestVersion.HTTP10`) | -| | `Double` (e.g. `(Double)HttpRequestVersion.HTTP10` or `(System.Double)HttpRequestVersion.HTTP10` or `(double)HttpRequestVersion.HTTP10`) | +| | | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------| +| **Category:** | Http | +| **Name:** | `HttpRequestVersion` | +| **Full Name:** | `Cortex.DataTypes.Http.HttpRequestVersion` | +| **Alias:** | N/A | +| **Description:** | Used to represent the version of HTTP to be used when making an HTTP request. | +| **Default Value:** | `(HttpRequestVersion)0` | +| **Can be used as:** | `HttpRequestVersion`, `Object`, `dynamic` | +| **Can be cast to:** | `Int16` (e.g. `(Int16)HttpRequestVersion.HTTP10` or `(System.Int16)HttpRequestVersion.HTTP10` or `(short)HttpRequestVersion.HTTP10`) | +| | `Int32` (e.g. `(Int32)HttpRequestVersion.HTTP10` or `(System.Int32)HttpRequestVersion.HTTP10` or `(int)HttpRequestVersion.HTTP10`) | +| | `Int64` (e.g. `(Int64)HttpRequestVersion.HTTP10` or `(System.Int64)HttpRequestVersion.HTTP10` or `(long)HttpRequestVersion.HTTP10`) | +| | `Single` (e.g. `(Single)HttpRequestVersion.HTTP10` or `(System.Single)HttpRequestVersion.HTTP10` or `(float)HttpRequestVersion.HTTP10`) | +| | `Double` (e.g. `(Double)HttpRequestVersion.HTTP10` or `(System.Double)HttpRequestVersion.HTTP10` or `(double)HttpRequestVersion.HTTP10`) | ## Values ### HTTP10 +| | | +|------------|---------------------------| +| **Name:** | HTTP10 | +| **Value:** | [Int32][] with value `0` | +| **Notes:** | HTTP 1.0 request version. | + ### HTTP11 +| | | +|------------|---------------------------| +| **Name:** | HTTP11 | +| **Value:** | [Int32][] with value `1` | +| **Notes:** | HTTP 1.1 request version. | + ### Property Editor Support - The Expression Editor is available for [Input][] properties where the data type is `HttpRequestVersion`. diff --git a/content/en/docs/2024.1/Reference/data-types/http/httpstatuscode.md b/content/en/docs/2024.1/Reference/data-types/http/httpstatuscode.md new file mode 100644 index 000000000..45fd32d2e --- /dev/null +++ b/content/en/docs/2024.1/Reference/data-types/http/httpstatuscode.md @@ -0,0 +1,80 @@ +--- +title: "HttpStatusCode" +linkTitle: "HttpStatusCode" +description: "Used to represent the status code returned by an HTTP request." +weight: 1 +--- + +# {{% param title %}} + +

(System.Net.HttpStatusCode)

+ +{{% alert type="information" title="Information" %}} Improvements to this page are planned for the future. {{% /alert %}} + +## Summary + +The `HttpStatusCode` data type is used to represent the status code returned by an HTTP request. + +`HttpStatusCode` is an [enum][Working with Enums] data type, which means it has a defined set of values, where each value has an associated [String][] name and [Int32][] value. + +| | | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------| +| **Category:** | Http | +| **Name:** | `HttpStatusCode` | +| **Full Name:** | `System.Net.HttpStatusCode` | +| **Alias:** | N/A | +| **Description:** | Used to represent the status code returned by an HTTP request. | +| **Default Value:** | `(HttpStatusCode)0` | +| **Can be used as:** | `HttpStatusCode`, `Object`, `dynamic` | +| **Can be cast to:** | `Int16` (e.g. `(Int16)HttpStatusCode.Continue` or `(System.Int16)HttpStatusCode.Continue` or `(short)HttpStatusCode.Continue`) | +| | `Int32` (e.g. `(Int32)HttpStatusCode.Continue` or `(System.Int32)HttpStatusCode.Continue` or `(int)HttpStatusCode.Continue`) | +| | `Int64` (e.g. `(Int64)HttpStatusCode.Continue` or `(System.Int64)HttpStatusCode.Continue` or `(long)HttpStatusCode.Continue`) | +| | `Single` (e.g. `(Single)HttpStatusCode.Continue` or `(System.Single)HttpStatusCode.Continue` or `(float)HttpStatusCode.Continue`) | +| | `Double` (e.g. `(Double)HttpStatusCode.Continue` or `(System.Double)HttpStatusCode.Continue` or `(double)HttpStatusCode.Continue`) | + +## Remarks + +### Property Editor Support + +- The Expression Editor is available for [Input][] properties where the data type is `HttpStatusCode`. +- The Literal Editor is available for [Input][] properties where the data type is `HttpStatusCode`. +- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `HttpStatusCode`. + +### Known Limitations + +None + +## See Also + +### Related Data Types + +- [Int32][] +- [String][] +- [HttpResponse][] +- [SoapResponse][] + +### Related Concepts + +- [Explicit Casting][] +- [Working with Enums][] + +### External Documentation + +- [System.Enum][] +- [System.Net.HttpStatusCode][] + +[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} +[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} +[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} + +[System.Enum]: {{< url path="MSDocs.DotNet.Api.System.Enum.MainDoc" >}} + +[Working with Enums]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Enums.MainDoc" >}} +[Explicit Casting]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Objects.ObjectCasting.ExplicitCast" >}} + +[String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}} +[Int32]: {{< url path="Cortex.Reference.DataTypes.Numbers.Int32.MainDoc" >}} + +[HttpResponse]: {{< url path = "Cortex.Reference.DataTypes.Http.Rest.HttpResponse.MainDoc" >}} +[SoapResponse]: {{< url path = "Cortex.Reference.DataTypes.Http.Soap.SoapResponse.MainDoc" >}} +[System.Net.HttpStatusCode]: {{< url path="MSDocs.DotNet.Api.System.Net.HttpStatusCode" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/http/requestverb.md b/content/en/docs/2024.1/Reference/data-types/http/requestverb.md index 21b8ecadb..f2a399ff4 100644 --- a/content/en/docs/2024.1/Reference/data-types/http/requestverb.md +++ b/content/en/docs/2024.1/Reference/data-types/http/requestverb.md @@ -13,39 +13,75 @@ weight: 1 ## Summary -The `RequestVerb` data type is used to represent the the type of an HTTP request. +The `RequestVerb` data type is used to represent the type of an HTTP request. `RequestVerb` is an [enum][Working with Enums] data type, which means it has a defined set of values, where each value has an associated [String][] name and [Int32][] value. -| | | -|-|-| -| **Category:** | Http | -| **Name:** | `RequestVerb` | -| **Full Name:** | `Cortex.DataTypes.Http.RequestVerb` | -| **Alias:** | N/A | -| **Description:** | Used to represent the type of an HTTP request. | -| **Default Value:** | `(RequestVerb)0` | -| **Can be used as:** | `RequestVerb`, `Object`, `dynamic` | -| **Can be cast to:** | `Int16` (e.g. `(Int16)RequestVerb.GET` or `(System.Int16)RequestVerb.GET` or `(short)RequestVerb.GET`) | -| | `Int32` (e.g. `(Int32)RequestVerb.GET` or `(System.Int32)RequestVerb.GET` or `(int)RequestVerb.GET`) | -| | `Int64` (e.g. `(Int64)RequestVerb.GET` or `(System.Int64)RequestVerb.GET` or `(long)RequestVerb.GET`) | -| | `Single` (e.g. `(Single)RequestVerb.GET` or `(System.Single)RequestVerb.GET` or `(float)RequestVerb.GET`) | -| | `Double` (e.g. `(Double)RequestVerb.GET` or `(System.Double)RequestVerb.GET` or `(double)RequestVerb.GET`) | +| | | +|---------------------|------------------------------------------------------------------------------------------------------------| +| **Category:** | Http | +| **Name:** | `RequestVerb` | +| **Full Name:** | `Cortex.DataTypes.Http.RequestVerb` | +| **Alias:** | N/A | +| **Description:** | Used to represent the type of an HTTP request. | +| **Default Value:** | `(RequestVerb)0` | +| **Can be used as:** | `RequestVerb`, `Object`, `dynamic` | +| **Can be cast to:** | `Int16` (e.g. `(Int16)RequestVerb.GET` or `(System.Int16)RequestVerb.GET` or `(short)RequestVerb.GET`) | +| | `Int32` (e.g. `(Int32)RequestVerb.GET` or `(System.Int32)RequestVerb.GET` or `(int)RequestVerb.GET`) | +| | `Int64` (e.g. `(Int64)RequestVerb.GET` or `(System.Int64)RequestVerb.GET` or `(long)RequestVerb.GET`) | +| | `Single` (e.g. `(Single)RequestVerb.GET` or `(System.Single)RequestVerb.GET` or `(float)RequestVerb.GET`) | +| | `Double` (e.g. `(Double)RequestVerb.GET` or `(System.Double)RequestVerb.GET` or `(double)RequestVerb.GET`) | ## Values ### GET +| | | +|------------|--------------------------| +| **Name:** | GET | +| **Value:** | [Int32][] with value `0` | +| **Notes:** | GET request. | + ### POST +| | | +|------------|--------------------------| +| **Name:** | POST | +| **Value:** | [Int32][] with value `1` | +| **Notes:** | POST request. | + ### PUT +| | | +|------------|--------------------------| +| **Name:** | PUT | +| **Value:** | [Int32][] with value `2` | +| **Notes:** | PUT request. | + ### DELETE +| | | +|------------|--------------------------| +| **Name:** | DELETE | +| **Value:** | [Int32][] with value `3` | +| **Notes:** | DELETE request. | + ### PATCH +| | | +|------------|--------------------------| +| **Name:** | PATCH | +| **Value:** | [Int32][] with value `4` | +| **Notes:** | PATCH request. | + ### HEAD +| | | +|------------|--------------------------| +| **Name:** | HEAD | +| **Value:** | [Int32][] with value `5` | +| **Notes:** | HEAD request. | + ## Remarks ### Property Editor Support diff --git a/content/en/docs/2024.1/Reference/data-types/http/rest/httprequest.md b/content/en/docs/2024.1/Reference/data-types/http/rest/httprequest.md index 4f1a2f19c..84171dcde 100644 --- a/content/en/docs/2024.1/Reference/data-types/http/rest/httprequest.md +++ b/content/en/docs/2024.1/Reference/data-types/http/rest/httprequest.md @@ -15,40 +15,103 @@ weight: 1 The `HttpRequest` data type is used to represent an HTTP REST request. -| | | -|-|-| -| **Category:** | Http | -| **Name:** | `HttpRequest` | -| **Full Name:** | `Cortex.DataTypes.Http.Rest.HttpRequest` | -| **Alias:** | N/A | -| **Description:** | Used to represent an HTTP REST request. | -| **Default Value:** | `null` | -| **Can be used as:** | `HttpRequest`, `Request`, `Object`, `dynamic` | -| **Can be cast to:** | N/A | +| | | +|---------------------|-----------------------------------------------| +| **Category:** | Http | +| **Name:** | `HttpRequest` | +| **Full Name:** | `Cortex.DataTypes.Http.Rest.HttpRequest` | +| **Alias:** | N/A | +| **Description:** | Used to represent an HTTP REST request. | +| **Default Value:** | `null` | +| **Can be used as:** | `HttpRequest`, `Request`, `Object`, `dynamic` | +| **Can be cast to:** | N/A | ## Properties ### Uri +The Uri represents the endpoint to send the REST request to. The value of this property may optionally be encrypted; for more information on how to encrypt this property, see [EncryptableText][]. + +| | | +|-----------------|---------------------------------------| +| Data Type | [EncryptableText][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [EncryptableText][] with value `$@""` | + ### QueryParameters +The QueryParameters represents the parameters to use in the REST request; these are appended as query string parameters to the Uri. + +| | | +|-----------------|---------------------------------------------| +| Data Type | [IDictionary][IDictionary] | +| Is [Advanced][] | `true` | +| Default Editor | [Expression][] | +| Default Value | [IDictionary][IDictionary] with no value | + ### Verb +The Verb represents the type of HTTP operation to use in the REST request. + +| | | +|-----------------|-----------------| +| Data Type | [RequestVerb][] | +| Is [Advanced][] | `false` | +| Default Editor | [Literal][] | +| Default Value | `GET` | + ### ContentType +The ContentType represents the type of the content used in the REST request. + +| | | +|-----------------|--------------------| +| Data Type | [String][] | +| Is [Advanced][] | `true` | +| Default Editor | [Literal][] | +| Default Value | [String] with value `"application/json"` | + ### Headers +The Headers represents the HTTP headers to include with the REST request. + +| | | +|-----------------|---------------------------------------------| +| Data Type | [IDictionary][IDictionary] | +| Is [Advanced][] | `true` | +| Default Editor | [Expression][] | +| Default Value | [IDictionary][IDictionary] with no value | + ### Body +The data to include in the body to be used (not relevant in GET and HEAD requests). The value of this property may optionally be encrypted; for more information on how to encrypt this property, see [EncryptableText][]. + +| | | +|-----------------|---------------------| +| Data Type | [EncryptableText][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [EncryptableText][] with value `$@""` | + ### HttpVersion +The HttpVersion represents the version of HTTP to use in the REST request. + +| | | +|-----------------|------------------------| +| Data Type | [HttpRequestVersion][] | +| Is [Advanced][] | `true` | +| Default Editor | [Literal][] | +| Default Value | `HTTP10` | + ## Remarks ### Property Editor Support -- The Expression Editor is available for [Input][] properties where the data type is `Request`. -- The Literal Editor is available for [Input][] properties where the data type is `Request`. -- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `Request`. +- The Expression Editor is available for [Input][] properties where the data type is `HttpRequest`. +- The Literal Editor is available for [Input][] properties where the data type is `HttpRequest`. +- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `HttpRequest`. ### Known Limitations @@ -58,8 +121,13 @@ None ### Related Data Types +- [EncryptableText][] +- [HttpRequestVersion][] - [HttpResponse][] +- [IDictionary][IDictionary] - [Request][] +- [RequestVerb][] +- [String][] ### Related Concepts @@ -75,3 +143,14 @@ None [Request]: {{< url path = "Cortex.Reference.DataTypes.Http.Request.MainDoc" >}} [HttpResponse]: {{< url path = "Cortex.Reference.DataTypes.Http.Rest.HttpResponse.MainDoc" >}} + +[Advanced]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.AdvancedProperties.MainDoc" >}} +[Literal]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.LiteralEditor.MainDoc" >}} +[Expression]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.MainDoc" >}} +[EncryptableText]: {{< url path="Cortex.Reference.DataTypes.Text.EncryptableText.MainDoc" >}} +[String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}} + +[IDictionary]: {{< url path="Cortex.Reference.DataTypes.Collections.IDictionary.MainDoc" >}} + +[RequestVerb]: {{< url path = "Cortex.Reference.DataTypes.Http.RequestVerb.MainDoc" >}} +[HttpRequestVersion]: {{< url path="Cortex.Reference.DataTypes.Http.HttpRequestVersion.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/http/rest/httpresponse.md b/content/en/docs/2024.1/Reference/data-types/http/rest/httpresponse.md index 2490e9bd1..055bc2ad9 100644 --- a/content/en/docs/2024.1/Reference/data-types/http/rest/httpresponse.md +++ b/content/en/docs/2024.1/Reference/data-types/http/rest/httpresponse.md @@ -15,27 +15,63 @@ weight: 1 The `HttpResponse` data type is used to represent an HTTP REST response. -| | | -|-|-| -| **Category:** | Http | -| **Name:** | `HttpResponse` | -| **Full Name:** | `Cortex.DataTypes.Http.Rest.HttpResponse` | -| **Alias:** | N/A | -| **Description:** | Used to represent an HTTP REST response. | -| **Default Value:** | `null` | -| **Can be used as:** | `HttpResponse`, `Object`, `dynamic` | -| **Can be cast to:** | N/A | +| | | +|---------------------|-------------------------------------------| +| **Category:** | Http | +| **Name:** | `HttpResponse` | +| **Full Name:** | `Cortex.DataTypes.Http.Rest.HttpResponse` | +| **Alias:** | N/A | +| **Description:** | Used to represent an HTTP REST response. | +| **Default Value:** | `null` | +| **Can be used as:** | `HttpResponse`, `Object`, `dynamic` | +| **Can be cast to:** | N/A | ## Properties ### ResponseBody +The ResponseBody represents the body of the REST response. + +| | | +|-----------------|----------------------------| +| Data Type | [dynamic][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [String] with value `$@""` | + ### ErrorMessage +The ErrorMessage is used represent any errors that occurred when executing the REST request. + +| | | +|-----------------|----------------------------| +| Data Type | [String][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [String] with value `$@""` | + ### Headers +The Headers are used to represent the HTTP headers returned in the REST response. + +| | | +|-----------------|---------------------------------------------------------| +| Data Type | [Dictionary][Dictionary] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [Dictionary][Dictionary] with no value | + ### StatusCode +The StatusCode is the status returned in the REST response. + +| | | +|-----------------|--------------------| +| Data Type | [HttpStatusCode][] | +| Is [Advanced][] | `false` | +| Default Editor | [Literal][] | +| Default Value | `OK` | + ## Remarks ### Property Editor Support @@ -52,7 +88,11 @@ None ### Related Data Types +- [Dictionary][Dictionary] +- [dynamic][] - [HttpRequest][] +- [HttpStatusCode][] +- [String][] ### Related Concepts @@ -60,10 +100,22 @@ None ### External Documentation -None +- [System.Net.HttpStatusCode][] [Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} [Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} [InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} [HttpRequest]: {{< url path = "Cortex.Reference.DataTypes.Http.Rest.HttpRequest.MainDoc" >}} + +[HttpStatusCode]: {{< url path = "Cortex.Reference.DataTypes.Http.HttpStatusCode.MainDoc" >}} + +[dynamic]: {{< url path="Cortex.Reference.DataTypes.All.dynamic.MainDoc" >}} +[Advanced]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.AdvancedProperties.MainDoc" >}} +[String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}} + +[Dictionary]: {{< url path="Cortex.Reference.DataTypes.Collections.Dictionary.MainDoc" >}} +[Literal]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.LiteralEditor.MainDoc" >}} +[Expression]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.MainDoc" >}} + +[System.Net.HttpStatusCode]: {{< url path="MSDocs.DotNet.Api.System.Net.HttpStatusCode" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/http/soap/soap11message.md b/content/en/docs/2024.1/Reference/data-types/http/soap/soap11message.md index 096d944dd..bea4c667c 100644 --- a/content/en/docs/2024.1/Reference/data-types/http/soap/soap11message.md +++ b/content/en/docs/2024.1/Reference/data-types/http/soap/soap11message.md @@ -30,8 +30,42 @@ The `Soap11Message` data type is used to represent a SOAP 1.1 message. ### Action +The Action represents the SOAP action to use in the SOAP request. +| | | +|--------------------|---------------------------| +| Data Type | [String][] | +| Is [Advanced][] | `false` | +| Default Editor | [Literal][] | +| Default Value | [String][] with value `""` | + +### Envelope + +The Envelope represents the content of the SOAP message. The value of this property may optionally be encrypted; for more information on how to encrypt this property, see [EncryptableText][]. + +| | | +|--------------------|---------------------------| +| Data Type | [EncryptableText][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [EncryptableText][] with value `$@""` | + +### Version + +The Version represents the SOAP version of the SOAP message. + +| | | +|--------------------|---------------------------| +| Data Type | [Int32][] | +| Is [Advanced][] | N/A see [Version is read-only][]| +| Default Editor | N/A see [Version is read-only][]| +| Default Value | [Int32] with value `11` | + ## Remarks +### Version is read-only + +[Version][Version Property] is a read-only property set to `11` and as such will not be visible in the property editor. + ### Property Editor Support - The Expression Editor is available for [Input][] properties where the data type is `Soap11Message`. @@ -46,9 +80,12 @@ None ### Related Data Types +- [EncryptableText][] +- [Int32] - [Soap12Message][] - [SoapMessage][] - [SoapRequest][] +- [String][] ### Related Concepts @@ -58,6 +95,9 @@ None None +[Version Property]: {{< ref "#version" >}} +[Version is Read-only]: {{< ref "#version-is-read-only" >}} + [Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} [Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} [InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} @@ -66,3 +106,11 @@ None [SoapMessage]: {{< url path = "Cortex.Reference.DataTypes.Http.Soap.SoapMessage.MainDoc" >}} [SoapRequest]: {{< url path = "Cortex.Reference.DataTypes.Http.Soap.SoapRequest.MainDoc" >}} + +[Int32]: {{< url path="Cortex.Reference.DataTypes.Numbers.Int32.MainDoc" >}} +[Advanced]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.AdvancedProperties.MainDoc" >}} +[Expression]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.MainDoc" >}} +[Literal]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.LiteralEditor.MainDoc" >}} + +[EncryptableText]: {{< url path="Cortex.Reference.DataTypes.Text.EncryptableText.MainDoc" >}} +[String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/http/soap/soapmessage.md b/content/en/docs/2024.1/Reference/data-types/http/soap/soapmessage.md index 99d2cb1cc..d5a56fef0 100644 --- a/content/en/docs/2024.1/Reference/data-types/http/soap/soapmessage.md +++ b/content/en/docs/2024.1/Reference/data-types/http/soap/soapmessage.md @@ -30,10 +30,32 @@ Any data type that is used to represent a SOAP message. ### Envelope +The Envelope represents the content of the SOAP message. The value of this property may optionally be encrypted; for more information on how to encrypt this property, see [EncryptableText][]. + +| | | +|--------------------|---------------------------| +| Data Type | [EncryptableText][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [EncryptableText][] with value `$@""` | + ### Version +The Version represents the SOAP version of the SOAP message. + +| | | +|--------------------|---------------------------| +| Data Type | [Int32][] | +| Is [Advanced][] | N/A see [Version is read-only][]| +| Default Editor | N/A see [Version is read-only][]| +| Default Value | [Int32] with value `11` or `12` set by [Soap11Message][] or [Soap12Message][] respectively | + ## Remarks +### Version is read-only + +[Version][Version Property] is a read-only property set by the derived classes [Soap11Message][] and [Soap12Message][] and as such will not be visible in the property editor. + ### Property Editor Support - The Expression Editor is available for [Input][] properties where the data type is `SoapMessage`. @@ -48,6 +70,8 @@ None ### Related Data Types +- [EncryptableText][] +- [Int32][] - [Soap11Message][] - [Soap12Message][] - [SoapRequest][] @@ -60,6 +84,9 @@ None None +[Version Property]: {{< ref "#version" >}} +[Version is Read-only]: {{< ref "#version-is-read-only" >}} + [Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} [Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} [InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} @@ -67,3 +94,8 @@ None [Soap12Message]: {{< url path = "Cortex.Reference.DataTypes.Http.Soap.Soap12Message.MainDoc" >}} [Soap11Message]: {{< url path = "Cortex.Reference.DataTypes.Http.Soap.Soap11Message.MainDoc" >}} [SoapRequest]: {{< url path = "Cortex.Reference.DataTypes.Http.Soap.SoapRequest.MainDoc" >}} + +[Int32]: {{< url path="Cortex.Reference.DataTypes.Numbers.Int32.MainDoc" >}} +[Advanced]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.AdvancedProperties.MainDoc" >}} +[Expression]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.MainDoc" >}} +[EncryptableText]: {{< url path="Cortex.Reference.DataTypes.Text.EncryptableText.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/http/soap/soaprequest.md b/content/en/docs/2024.1/Reference/data-types/http/soap/soaprequest.md index 4ff7224a0..e183035ba 100644 --- a/content/en/docs/2024.1/Reference/data-types/http/soap/soaprequest.md +++ b/content/en/docs/2024.1/Reference/data-types/http/soap/soaprequest.md @@ -28,14 +28,58 @@ The `SoapRequest` data type is used to represent a SOAP request. ## Properties +### Uri + +The Uri represents the endpoint to send the SOAP message to. The value of this property may optionally be encrypted; for more information on how to encrypt this property, see [EncryptableText][]. + +| | | +|--------------------|---------------------------| +| Data Type | [EncryptableText][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [EncryptableText][] with value `$@""` | + ### SoapMessage -### Uri +The SoapMessage represents the SOAP message to send. + +| | | +|--------------------|---------------------------| +| Data Type | [SoapMessage][] | +| Is [Advanced][] | `false` | +| Default Editor | [Literal][] | +| Default Value | [SoapMessage] with value shown below | + +```json +{ + "Action": "", + "Envelope": "", + "Version": 11 +} +``` ### Headers +The Headers are used to represent the HTTP headers to add to the request. + +| | | +|--------------------|---------------------------| +| Data Type | [IDictionary][IDictionary] | +| Is [Advanced][] | `true` | +| Default Editor | [Expression][] | +| Default Value | [IDictionary][IDictionary] with no value | + ### HttpVersion +The HttpVersion represents the version of HTTP to use in the request. + +| | | +|--------------------|---------------------------| +| Data Type | [HttpRequestVersion][] | +| Is [Advanced][] | `true` | +| Default Editor | [Literal][] | +| Default Value | `HTTP10` | + ## Remarks ### Property Editor Support @@ -52,9 +96,13 @@ None ### Related Data Types +- [EncryptableText][] +- [HttpRequestVersion][] +- [IDictionary][IDictionary] - [Request][] - [Soap11Message][] - [Soap12Message][] +- [SoapMessage][] - [SoapResponse][] ### Related Concepts @@ -73,3 +121,13 @@ None [Soap12Message]: {{< url path = "Cortex.Reference.DataTypes.Http.Soap.Soap12Message.MainDoc" >}} [Request]: {{< url path = "Cortex.Reference.DataTypes.Http.Request.MainDoc" >}} [SoapResponse]: {{< url path = "Cortex.Reference.DataTypes.Http.Soap.SoapResponse.MainDoc" >}} + +[IDictionary]: {{< url path="Cortex.Reference.DataTypes.Collections.IDictionary.MainDoc" >}} +[SoapMessage]: {{< url path = "Cortex.Reference.DataTypes.Http.Soap.SoapMessage.MainDoc" >}} + +[Advanced]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.AdvancedProperties.MainDoc" >}} +[Expression]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.MainDoc" >}} +[Literal]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.LiteralEditor.MainDoc" >}} + +[EncryptableText]: {{< url path="Cortex.Reference.DataTypes.Text.EncryptableText.MainDoc" >}} +[HttpRequestVersion]: {{< url path="Cortex.Reference.DataTypes.Http.HttpRequestVersion.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/http/soap/soapresponse.md b/content/en/docs/2024.1/Reference/data-types/http/soap/soapresponse.md index b3cd8de57..ca10bf182 100644 --- a/content/en/docs/2024.1/Reference/data-types/http/soap/soapresponse.md +++ b/content/en/docs/2024.1/Reference/data-types/http/soap/soapresponse.md @@ -30,12 +30,48 @@ The `SoapResponse` data type is used to represent a SOAP response. ### ResponseEnvelope +The ResponseEnvelope is used to represent the content of the SOAP response. + +| | | +|--------------------|---------------------------| +| Data Type | [dynamic][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [String] with value `$@""` | + ### ErrorMessage +The ErrorMessage is used represent any errors that occurred when executing the SOAP request. + +| | | +|--------------------|---------------------------| +| Data Type | [String][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [String] with value `$@""` | + ### Headers +The Headers are used to represent the HTTP headers returned in the SOAP response. + +| | | +|--------------------|---------------------------| +| Data Type | [IDictionary][IDictionary] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [IDictionary][IDictionary] with no value | + ### StatusCode +The StatusCode is the status returned in the SOAP response. + +| | | +|--------------------|---------------------------| +| Data Type | [HttpStatusCode][] | +| Is [Advanced][] | `false` | +| Default Editor | [Literal][] | +| Default Value | `OK` | + ## Remarks ### Property Editor Support @@ -52,6 +88,10 @@ None ### Related Data Types +- [dynamic][] +- [IDictionary][IDictionary] +- [HttpStatusCode][] +- [String][] - [SoapRequest][] ### Related Concepts @@ -60,10 +100,21 @@ None ### External Documentation -None +- [System.Net.HttpStatusCode][] [Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} [Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} [InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} [SoapRequest]: {{< url path = "Cortex.Reference.DataTypes.Http.Soap.SoapRequest.MainDoc" >}} + +[dynamic]: {{< url path="Cortex.Reference.DataTypes.All.dynamic.MainDoc" >}} +[Advanced]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.AdvancedProperties.MainDoc" >}} +[Expression]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.MainDoc" >}} +[String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}} + +[IDictionary]: {{< url path="Cortex.Reference.DataTypes.Collections.IDictionary.MainDoc" >}} +[Literal]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.LiteralEditor.MainDoc" >}} + +[System.Net.HttpStatusCode]: {{< url path="MSDocs.DotNet.Api.System.Net.HttpStatusCode" >}} +[HttpStatusCode]: {{< url path = "Cortex.Reference.DataTypes.Http.HttpStatusCode.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/microsoft365/authentication/oauth/microsoft365oauthcertificatecredentials.md b/content/en/docs/2024.1/Reference/data-types/microsoft365/authentication/oauth/microsoft365oauthcertificatecredentials.md index b985049a2..b6a123ee6 100644 --- a/content/en/docs/2024.1/Reference/data-types/microsoft365/authentication/oauth/microsoft365oauthcertificatecredentials.md +++ b/content/en/docs/2024.1/Reference/data-types/microsoft365/authentication/oauth/microsoft365oauthcertificatecredentials.md @@ -1,7 +1,7 @@ --- title: "Microsoft365OAuthCertificateCredentials" linkTitle: "Microsoft365OAuthCertificateCredentials" -description: "Used to represent public key credentials required to authenticate with a server hosted by Outlook via OAuth." +description: "Used to represent public key credentials required to authenticate, via OAuth, with a server hosted by Outlook." weight: 1 --- @@ -13,7 +13,7 @@ weight: 1 ## Summary -The `Microsoft365OAuthCertificateCredentials` data type is used to represent public key credentials required to authenticate with a server hosted by Outlook via OAuth. +The `Microsoft365OAuthCertificateCredentials` data type is used to represent public key credentials required to authenticate, via OAuth, with a server hosted by Outlook. | | | |-|-| @@ -21,23 +21,68 @@ The `Microsoft365OAuthCertificateCredentials` data type is used to represent pub | **Name:** | `Microsoft365OAuthCertificateCredentials` | | **Full Name:** | `Cortex.DataTypes.Microsoft365.Authentication.OAuth.Microsoft365OAuthCertificateCredentials` | | **Alias:** | N/A | -| **Description:** | Used to represent public key credentials required to authenticate with a server hosted by Outlook via OAuth. | +| **Description:** | Used to represent public key credentials required to authenticate, via OAuth, with a server hosted by Outlook. | | **Default Value:** | null | | **Can be used as:** | `Microsoft365OAuthCertificateCredentials`, `Microsoft365Credentials`, `Object`, `dynamic` | | **Can be cast to:** | N/A | ## Properties -### ObjectId - ### CertificatePath +The CertificatePath is used to define the path pointing to the X.509 certificate file to be used for authentication via OAuth, the certificate file must be accessible from the server executing the flow. The value of this property may optionally be encrypted; for more information on how to encrypt this property, see [EncryptableText][]. + +| | | +|--------------------|---------------------------| +| Data Type | [EncryptableText][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [EncryptableText][] with value `$@""` | + ### CertificatePassword +The CertificatePassword is used to define the password associated with the certificate file at the [CertificatePath][]. This property is an [EncryptedText][] and so it must be encrypted; for more information on how to encrypt the password, see [EncryptedText][]. + +| | | +|--------------------|---------------------------| +| Data Type | [EncryptedText][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [EncryptedText][] with value `""` | + ### ClientId +The ClientId is used to define the client ID of the client application created to allow authentication via OAuth. The value of this property may optionally be encrypted; for more information on how to encrypt this property, see [EncryptableText][]. + +| | | +|--------------------|---------------------------| +| Data Type | [EncryptableText][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [EncryptableText][] with value `""` | + ### TenantId +The TenantId is used to define the Microsoft365 tenant in which the client application is registered. The value of this property may optionally be encrypted; for more information on how to encrypt this property, see [EncryptableText][]. + +| | | +|--------------------|---------------------------| +| Data Type | [EncryptableText][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [EncryptableText][] with value `""` | + +### ObjectId + +The ObjectId of the user who is authenticating. The value of this property may optionally be encrypted; for more information on how to encrypt this property, see [EncryptableText][]. + +| | | +|--------------------|---------------------------| +| Data Type | [EncryptableText][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [EncryptableText][] with value `""` | + ## Remarks ### Property Editor Support @@ -67,9 +112,13 @@ None None +[CertificatePath]: {{< ref "#certificatepath">}} + [Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} [Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} [InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} +[Expression]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.MainDoc" >}} +[Advanced]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.AdvancedProperties.MainDoc" >}} [Working with Email]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Email.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/microsoft365/authentication/oauth/microsoft365oauthcredentials.md b/content/en/docs/2024.1/Reference/data-types/microsoft365/authentication/oauth/microsoft365oauthcredentials.md index b593553dd..d4f489e63 100644 --- a/content/en/docs/2024.1/Reference/data-types/microsoft365/authentication/oauth/microsoft365oauthcredentials.md +++ b/content/en/docs/2024.1/Reference/data-types/microsoft365/authentication/oauth/microsoft365oauthcredentials.md @@ -1,7 +1,7 @@ --- title: "Microsoft365OAuthCredentials" linkTitle: "Microsoft365OAuthCredentials" -description: "Used to represent client credentials required to authenticate with a server hosted by Outlook via OAuth." +description: "Used to represent client credentials required to authenticate, via OAuth, with a server hosted by Outlook." weight: 1 --- @@ -13,7 +13,7 @@ weight: 1 ## Summary -The `Microsoft365OAuthCredentials` data type is used to represent client credentials required to authenticate with a server hosted by Outlook via OAuth. +The `Microsoft365OAuthCredentials` data type is used to represent client credentials required to authenticate, via OAuth, with a server hosted by Outlook. | | | |-|-| @@ -21,21 +21,56 @@ The `Microsoft365OAuthCredentials` data type is used to represent client credent | **Name:** | `Microsoft365OAuthCredentials` | | **Full Name:** | `Cortex.DataTypes.Microsoft365.Authentication.OAuth.Microsoft365OAuthCredentials` | | **Alias:** | N/A | -| **Description:** | Used to represent client credentials required to authenticate with a server hosted by Outlook via OAuth. | +| **Description:** | Used to represent client credentials required to authenticate, via OAuth, with a server hosted by Outlook. | | **Default Value:** | null | | **Can be used as:** | `Microsoft365OAuthCredentials`, `Microsoft365Credentials`, `Object`, `dynamic` | | **Can be cast to:** | N/A | ## Properties -### ObjectId - ### ClientId +The ClientId is used to define the client ID of the client application created to allow authentication via OAuth. The value of this property may optionally be encrypted; for more information on how to encrypt this property, see [EncryptableText][]. +| | | +|--------------------|---------------------------| +| Data Type | [EncryptableText][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [EncryptableText][] with value `""` | + ### ClientSecret +The ClientSecret is used to define the secret used to authenticate with the client application, this value should be kept secret. This property is an [EncryptedText][] and so it must be encrypted; for more information on how to encrypt the password, see [EncryptedText][]. + +| | | +|--------------------|---------------------------| +| Data Type | [EncryptedText][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [EncryptedText][] with value `""` | + ### TenantId +The TenantId is used to define the Microsoft365 tenant in which the client application is registered. The value of this property may optionally be encrypted; for more information on how to encrypt this property, see [EncryptableText][]. + +| | | +|--------------------|---------------------------| +| Data Type | [EncryptableText][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [EncryptableText][] with value `""` | + +### ObjectId + +The ObjectId of the user who is authenticating. The value of this property may optionally be encrypted; for more information on how to encrypt this property, see [EncryptableText][]. + +| | | +|--------------------|---------------------------| +| Data Type | [EncryptableText][] | +| Is [Advanced][] | `false` | +| Default Editor | [Expression][] | +| Default Value | [EncryptableText][] with value `""` | + ## Remarks ### Property Editor Support @@ -68,6 +103,8 @@ None [Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} [Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} [InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} +[Expression]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.MainDoc" >}} +[Advanced]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.AdvancedProperties.MainDoc" >}} [Working with Email]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Email.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/text/char.md b/content/en/docs/2024.1/Reference/data-types/text/char.md index 0e40f4470..ffa20506c 100644 --- a/content/en/docs/2024.1/Reference/data-types/text/char.md +++ b/content/en/docs/2024.1/Reference/data-types/text/char.md @@ -2,6 +2,7 @@ title: "Char" linkTitle: "Char" description: "Used to represent unicode characters." +weight: 1 --- # {{% param title %}} diff --git a/content/en/docs/2024.1/Reference/data-types/text/cultureinfo.md b/content/en/docs/2024.1/Reference/data-types/text/cultureinfo.md index fe078d51d..428c0e49f 100644 --- a/content/en/docs/2024.1/Reference/data-types/text/cultureinfo.md +++ b/content/en/docs/2024.1/Reference/data-types/text/cultureinfo.md @@ -2,39 +2,115 @@ title: "CultureInfo" linkTitle: "CultureInfo" description: "Used to represent information about a specific culture, including the names for the culture, the writing system, the calendar used, the sort order of strings, and formatting for dates and numbers." +weight: 1 --- # {{% param title %}}

(System.Globalization.CultureInfo)

-{{< workinprogress >}} +{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}} ## Summary +The `CultureInfo` data type is used to represent information about a specific culture, including the names for the culture, the writing system, the calendar used, the sort order of strings, and formatting for dates and numbers. + +| | | +|-|-| +| **Category:** | Text | +| **Name:** | `CultureInfo` | +| **Full Name:** | `System.Globalization.CultureInfo` | +| **Alias:** | N/A | +| **Description:** | Used to represent information about a specific culture. | +| **Default Value:** | `null` | +| **Can be used as:** | `CultureInfo`, `object`, `dynamic` | +| **Can be cast to:** | N/A | + ## Remarks -### Create a CultureInfo +### Types of CultureInfo + +There are four types of CultureInfo: + +- [Invariant Culture][] +- [Current Culture][] +- [Neutral Culture][] +- [Specific Culture][] + +#### Invariant Culture + +The invariant culture is culture-insensitive. It is associated with the English language but not with any country/region, as such the casing conventions, the sort order of strings, and formatting for dates and numbers will remain consistent across systems. This can be useful when persisting data in a culture-independent format. + +There are two ways to create an invariant culture: + +- `CultureInfo.InvariantCulture` +- `new CultureInfo("")` + +#### Current Culture + +The current culture is culture-sensitive. It is used to represent the current culture of the server running {{% ctx %}}, and as such the casing conventions, the sort order of strings, and formatting for dates and numbers may change across systems. This can be useful for providing date time in the correct format for a user. + +There is one way to get the current culture: + +- `CultureInfo.CurrentCulture` + +#### Neutral Culture + +The neutral culture is culture-sensitive. It is associated with a language, but not with any country/region. -### Convert CultureInfo to Text +Neutral Culture can be created by specifying the language but not the country (e.g. `new CultureInfo("en")` for english with no associated country). + +#### Specific Culture + +The culture can be explicitly specified to use a particular format (e.g. `CultureInfo("en-GB")` for the standard UK english culture). +If the resources for a specific culture are not available in the operating system, the resources for the associated neutral culture are used. + +For a comprehensive list of cultures please see [Supported Culture Codes][]. + +### Invalid CultureInfo + +If an invalid CultureInfo (e.g. `new CultureInfo(“enaa”)`), is provided to a block property that requires an [IFormatProvider][] data type, (i.e. [Format Text With Values][FormatTextWithValues] block) a [CultureInfoNotFoundException][] will be thrown. ### Property Editor Support +- The Expression Editor is available for [Input][] properties where the data type is `CultureInfo`. +- The Literal Editor is available for [Input][] properties where the data type is `CultureInfo`. +- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `CultureInfo`. + ### Known Limitations +None + ## See Also ### Related Data Types +- [IFormatProvider][] + ### Related Concepts +- [Working with Text][] + ### External Documentation -TODO: +- [Supported Culture Codes][] +- [System.Globalization.CultureInfo][] +- [System.Globalization.CultureInfoNotFoundException][CultureInfoNotFoundException] + +[CultureInfoNotFoundException]: {{< url path = "MSDocs.DotNet.Api.System.Globalization.CultureInfoNotFoundException">}} +[Supported Culture Codes]: {{< url path = "MSDocs.CSharp.SupportedCultureCodes">}} + +[Invariant Culture]: {{< ref "#invariant-culture" >}} +[Current Culture]: {{< ref "#current-culture" >}} +[Specific Culture]: {{< ref "#specific-culture" >}} +[Neutral Culture]: {{< ref "#neutral-culture" >}} + +[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} +[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} +[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} + +[Working with Text]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Text.MainDoc" >}} -* If the culture identifier is empty e.g (new CultureInfo("")), cultureInfo is set to InvariantCulture. -* If the culture does not exist, the operating system will create a custom culture using the culture identifier. -* As well as the default InvariantCulture you can also use the culture of the system (CultureInfo.CurrentCulture) or provide a new culture info (new CultureInfo("en-GB")). -* Note about formatProvider and CultureInfo: If an invalid CultureInfo is provided (e.g. new CultureInfo("enaa")), a CultureNotFoundException will be thrown. -* Talk about CultureInfo.InvariantCulture -* Talk about CultureInfo.CurrentCulture +[System.Globalization.CultureInfo]: {{< url path="MSDocs.DotNet.Api.System.Globalization.CultureInfo" >}} +[FormatTextWithValues]: {{< url path="Cortex.Reference.Blocks.Text.FormatText.FormatTextWithValues.MainDoc" >}} +[IFormatProvider]: {{< url path="Cortex.Reference.DataTypes.Text.IFormatProvider.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/text/encoding.md b/content/en/docs/2024.1/Reference/data-types/text/encoding.md index ac459c4c3..99f8b08e9 100644 --- a/content/en/docs/2024.1/Reference/data-types/text/encoding.md +++ b/content/en/docs/2024.1/Reference/data-types/text/encoding.md @@ -1,31 +1,65 @@ --- title: "Encoding" linkTitle: "Encoding" -description: "The data type that all encodings inherit from. An encoding is used to represent a specific character encoding (e.g. ASCII, UTF8, Unicode)." +description: "Any data type used to represent a specific character encoding (e.g. ASCII, UTF8, Unicode)." +weight: 1 --- # {{% param title %}}

(System.Text.Encoding)

-{{< workinprogress >}} +{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}} ## Summary -## Remarks +Any data type used to represent a specific character encoding (e.g. ASCII, UTF8, Unicode). -### Create an Encoding +| | | +|-|-| +| **Category:** | Text | +| **Name:** | `Encoding` | +| **Full Name:** | `System.Text.Encoding` | +| **Alias:** | N/A | +| **Description:** | Any data type used to represent a specific character encoding (e.g. ASCII, UTF8, Unicode). | +| **Default Value:** | `null` | +| **Can be used as:** | `Encoding`, `object`, `dynamic` | +| **Can be cast to:** | N/A | -### Convert Encoding to Text +## Remarks ### Property Editor Support +- The Expression Editor is available for [Input][] properties where the data type is `Encoding`. +- The Literal Editor is available for [Input][] properties where the data type is `Encoding`. +- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `Encoding`. + ### Known Limitations +None + ## See Also ### Related Data Types +- [UnicodeEncoding][] +- [UTF32Encoding][] +- [UTF8Encoding][] + ### Related Concepts +- [Working with Text][] + ### External Documentation + +- [System.Text.Encoding][Encoding] + +[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} +[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} +[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} + +[Working with Text]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Text.MainDoc" >}} +[Encoding]: {{< url path = "MSDocs.DotNet.Api.System.Text.Encoding">}} +[UnicodeEncoding]: {{< url path = "Cortex.Reference.DataTypes.Text.UnicodeEncoding.MainDoc">}} +[UTF32Encoding]: {{< url path = "Cortex.Reference.DataTypes.Text.UTF32Encoding.MainDoc">}} +[UTF8Encoding]: {{< url path = "Cortex.Reference.DataTypes.Text.UTF8Encoding.MainDoc">}} diff --git a/content/en/docs/2024.1/Reference/data-types/text/encryptabletext.md b/content/en/docs/2024.1/Reference/data-types/text/encryptabletext.md index 15831ee0a..571986655 100644 --- a/content/en/docs/2024.1/Reference/data-types/text/encryptabletext.md +++ b/content/en/docs/2024.1/Reference/data-types/text/encryptabletext.md @@ -2,30 +2,62 @@ title: "EncryptableText" linkTitle: "EncryptableText" description: "Used to represent text that can be, but does not need to be encrypted." +weight: 1 --- # {{% param title %}}

(Cortex.DataTypes.Text.EncryptableText)

-{{< workinprogress >}} +{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}} ## Summary -## Remarks +The `EncryptableText` datatype is used to represent text that can be, but does not need to be encrypted. -### Create an EncryptableText +| | | +|-|-| +| **Category:** | Text | +| **Name:** | `EncryptableText` | +| **Full Name:** | `Cortex.DataTypes.Text.EncryptableText` | +| **Alias:** | N/A | +| **Description:** | Used to represent text that can be, but does not need to be encrypted . | +| **Default Value:** | `null` | +| **Can be used as:** | `EncryptableText`, `object`, `dynamic` | +| **Can be cast to:** | `string` | -### Convert EncryptableText to Text +## Remarks ### Property Editor Support +- The Expression Editor is available for [Input][] properties where the data type is `EncryptableText`. +- The Literal Editor is available for [Input][] properties where the data type is `EncryptableText`. +- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `EncryptableText`. + ### Known Limitations +None + ## See Also ### Related Data Types +- [EncryptedText] +- [String] + ### Related Concepts +- [Working with Text] + ### External Documentation + +None + +[EncryptedText]: {{< url path="Cortex.Reference.DataTypes.Text.EncryptedText.MainDoc" >}} +[String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}} + +[Working with Text]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Text.MainDoc" >}} + +[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} +[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} +[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/text/encryptedtext.md b/content/en/docs/2024.1/Reference/data-types/text/encryptedtext.md index 4858aa036..ae64300ec 100644 --- a/content/en/docs/2024.1/Reference/data-types/text/encryptedtext.md +++ b/content/en/docs/2024.1/Reference/data-types/text/encryptedtext.md @@ -2,30 +2,62 @@ title: "EncryptedText" linkTitle: "EncryptedText" description: "Used to represent text that must be encrypted." +weight: 1 --- # {{% param title %}}

(Cortex.DataTypes.Text.EncryptedText)

-{{< workinprogress >}} +{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}} ## Summary -## Remarks +The `EncryptedText` datatype is used to represent text that must be encrypted. -### Create an EncryptedText +| | | +|-|-| +| **Category:** | Text | +| **Name:** | `EncryptedText` | +| **Full Name:** | `Cortex.DataTypes.Text.EncryptedText` | +| **Alias:** | N/A | +| **Description:** | Used to represent text that must be encrypted . | +| **Default Value:** | `null` | +| **Can be used as:** | `EncryptedText`, `object`, `dynamic` | +| **Can be cast to:** | `string` | -### Convert EncryptedText to Text +## Remarks ### Property Editor Support +- The Expression Editor is available for [Input][] properties where the data type is `EncryptedText`. +- The Literal Editor is available for [Input][] properties where the data type is `EncryptedText`. +- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `EncryptedText`. + ### Known Limitations +None + ## See Also ### Related Data Types +- [EncryptableText][] +- [String][] + ### Related Concepts +- [Working with Text] + ### External Documentation + +None + +[EncryptableText]: {{< url path="Cortex.Reference.DataTypes.Text.EncryptableText.MainDoc" >}} +[String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}} + +[Working with Text]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Text.MainDoc" >}} + +[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} +[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} +[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/text/iformatprovider.md b/content/en/docs/2024.1/Reference/data-types/text/iformatprovider.md index b4ec69239..60489d7d1 100644 --- a/content/en/docs/2024.1/Reference/data-types/text/iformatprovider.md +++ b/content/en/docs/2024.1/Reference/data-types/text/iformatprovider.md @@ -1,31 +1,63 @@ --- title: "IFormatProvider" linkTitle: "IFormatProvider" -description: "The data type providing the contract that all data types that control formatting must implement." +description: "Any data type used to control formatting." +weight: 1 --- # {{% param title %}}

(System.IFormatProvider)

-{{< workinprogress >}} +{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}} ## Summary -## Remarks +Any data type used to control formatting. -### Create a data type that implements IFormatProvider +| | | +|-|-| +| **Category:** | Text | +| **Name:** | `IFormatProvider` | +| **Full Name:** | `System.IFormatProvider` | +| **Alias:** | N/A | +| **Description:** | Any data type used to control formatting. | +| **Default Value:** | `null` | +| **Can be used as:** | `IFormatProvider`, `object`, `dynamic` | +| **Can be cast to:** | N/A | -### Convert IFormatProvider to Text +## Remarks ### Property Editor Support +- The Expression Editor is available for [Input][] properties where the data type is `IFormatProvider`. +- The Literal Editor is available for [Input][] properties where the data type is `IFormatProvider`. +- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `IFormatProvider`. + ### Known Limitations +None + ## See Also ### Related Data Types +- [CultureInfo][] + ### Related Concepts +- [Working with Text][] + ### External Documentation + +- [System.IFormatProvider][IFormatProvider] + +[Working with Text]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Text.MainDoc" >}} + +[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} +[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} +[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} + +[IFormatProvider]: {{< url path="MSDocs.DotNet.Api.System.IFormatProvider" >}} + +[CultureInfo]: {{< url path="Cortex.Reference.DataTypes.Text.CultureInfo.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/text/regex/_index.md b/content/en/docs/2024.1/Reference/data-types/text/regex/_index.md index 8bde0833f..fd0bae889 100644 --- a/content/en/docs/2024.1/Reference/data-types/text/regex/_index.md +++ b/content/en/docs/2024.1/Reference/data-types/text/regex/_index.md @@ -1,6 +1,6 @@ --- title: "Regex" linkTitle: "Regex" -description: "Used to represent Regex data types" +description: "Data types used when working with Regex." weight: 1 --- \ No newline at end of file diff --git a/content/en/docs/2024.1/Reference/data-types/text/regex/match.md b/content/en/docs/2024.1/Reference/data-types/text/regex/match.md index 2471f9adb..6e32fef61 100644 --- a/content/en/docs/2024.1/Reference/data-types/text/regex/match.md +++ b/content/en/docs/2024.1/Reference/data-types/text/regex/match.md @@ -127,11 +127,8 @@ None [Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} [InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} [Expression]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.MainDoc" >}} -[Literal]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.LiteralEditor.MainDoc" >}} [Advanced]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.AdvancedProperties.MainDoc" >}} -[System.Text.RegularExpressions.Match]: {{< url path="MSDocs.DotNet.Api.System.Text.RegularExpressions.Match" >}} - [Dictionary]: {{}} [Int32]: {{}} [String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/text/searchoptions.md b/content/en/docs/2024.1/Reference/data-types/text/searchoptions.md index 0bae9db32..dc12ef04d 100644 --- a/content/en/docs/2024.1/Reference/data-types/text/searchoptions.md +++ b/content/en/docs/2024.1/Reference/data-types/text/searchoptions.md @@ -2,6 +2,7 @@ title: "SearchOptions" linkTitle: "SearchOptions" description: "Used to specify how text is matched when performing a search (i.e. text matches the specified literal text, regex or pattern)." +weight: 1 --- # {{% param title %}} diff --git a/content/en/docs/2024.1/Reference/data-types/text/string.md b/content/en/docs/2024.1/Reference/data-types/text/string.md index 03bf629a1..2ea47eaee 100644 --- a/content/en/docs/2024.1/Reference/data-types/text/string.md +++ b/content/en/docs/2024.1/Reference/data-types/text/string.md @@ -2,6 +2,7 @@ title: "String" linkTitle: "String" description: "Used to represent text." +weight: 1 --- # {{% param title %}} diff --git a/content/en/docs/2024.1/Reference/data-types/text/stringcomparer.md b/content/en/docs/2024.1/Reference/data-types/text/stringcomparer.md index 2f9879829..470dffd7b 100644 --- a/content/en/docs/2024.1/Reference/data-types/text/stringcomparer.md +++ b/content/en/docs/2024.1/Reference/data-types/text/stringcomparer.md @@ -2,6 +2,7 @@ title: "StringComparer" linkTitle: "StringComparer" description: "Used to compare two pieces of text against each other." +weight: 1 --- # {{% param title %}} diff --git a/content/en/docs/2024.1/Reference/data-types/text/stringcomparison.md b/content/en/docs/2024.1/Reference/data-types/text/stringcomparison.md index 97acfa331..c162595ef 100644 --- a/content/en/docs/2024.1/Reference/data-types/text/stringcomparison.md +++ b/content/en/docs/2024.1/Reference/data-types/text/stringcomparison.md @@ -1,31 +1,76 @@ --- title: "StringComparison" linkTitle: "StringComparison" -description: "Used to indicate how 2 pieces of text are compared against each other (i.e. which culture to use and whether to consider case or not)." +description: "Used to indicate how two pieces of text are compared against each other (i.e. which culture to use and whether to consider case or not)." +weight: 1 --- # {{% param title %}}

(System.StringComparison)

-{{< workinprogress >}} +{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}} ## Summary -## Remarks +The `StringComparison` data type is used to indicate how two pieces of text are compared against each other (i.e. which culture to use and whether to consider case or not). + +`StringComparison` is an [enum][Working with Enums] data type, which means it has a defined set of values, where each value has an associated [String][] name and [Int32][] value. -### Create a StringComparison +| | | +|-|-| +| **Category:** | Text | +| **Name:** | `StringComparison` | +| **Full Name:** | `System.StringComparison` | +| **Alias:** | N/A | +| **Description:** | Used to indicate how two pieces of text are compared against each other (i.e. which culture to use and whether to consider case or not). | +| **Default Value:** | `(StringComparison)0` | +| **Can be used as:** | `StringComparison`, `object`, `dynamic` | +| **Can be cast to:** | `Int16` (e.g. `(Int16)StringComparison.CurrentCulture` or `(System.Int16)StringComparison.CurrentCulture` or `(short)StringComparison.CurrentCulture`) | +| | `Int32` (e.g. `(Int32)StringComparison.CurrentCulture` or `(System.Int32)StringComparison.CurrentCulture` or `(int)StringComparison.CurrentCulture`) | +| | `Int64` (e.g. `(Int64)StringComparison.CurrentCulture` or `(System.Int64)StringComparison.CurrentCulture` or `(long)StringComparison.CurrentCulture`) | +| | `Single` (e.g. `(Single)StringComparison.CurrentCulture` or `(System.Single)StringComparison.CurrentCulture` or `(float)StringComparison.CurrentCulture`) | +| | `Double` (e.g. `(Double)StringComparison.CurrentCulture` or `(System.Double)StringComparison.CurrentCulture` or `(double)StringComparison.CurrentCulture`) | -### Convert StringComparison to Text +## Remarks ### Property Editor Support +- The Expression Editor is available for [Input][] properties where the data type is `StringComparison`. +- The Literal Editor is available for [Input][] properties where the data type is `StringComparison`. +- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `StringComparison`. + ### Known Limitations +None + ## See Also ### Related Data Types +- [StringComparer][] + ### Related Concepts +- [Working With Text][] +- [Working With Enums][] + ### External Documentation + +- [System.StringComparison][StringComparison] +- [System.Enum][] + +[Working With Text]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Text.MainDoc" >}} + +[StringComparer]: {{< url path="Cortex.Reference.DataTypes.Text.StringComparer.MainDoc" >}} +[StringComparison]: {{< url path="MSDocs.DotNet.Api.System.StringComparison" >}} + +[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} +[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} +[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} + +[String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}} +[Int32]: {{< url path="Cortex.Reference.DataTypes.Numbers.Int32.MainDoc" >}} + +[Working with Enums]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Enums.MainDoc" >}} +[System.Enum]: {{< url path="MSDocs.DotNet.Api.System.Enum.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/data-types/text/stringsplitoptions.md b/content/en/docs/2024.1/Reference/data-types/text/stringsplitoptions.md index a9068439c..1325f13fa 100644 --- a/content/en/docs/2024.1/Reference/data-types/text/stringsplitoptions.md +++ b/content/en/docs/2024.1/Reference/data-types/text/stringsplitoptions.md @@ -2,6 +2,7 @@ title: "StringSplitOptions" linkTitle: "StringSplitOptions" description: "Used to specify settings for splitting text (i.e. whether to include or remove empty entries from results)." +weight: 1 --- # {{% param title %}} diff --git a/content/en/docs/2024.1/Reference/data-types/text/textdecodingerrorcode.md b/content/en/docs/2024.1/Reference/data-types/text/textdecodingerrorcode.md index a21af1381..7a40a1c8a 100644 --- a/content/en/docs/2024.1/Reference/data-types/text/textdecodingerrorcode.md +++ b/content/en/docs/2024.1/Reference/data-types/text/textdecodingerrorcode.md @@ -2,6 +2,7 @@ title: "TextDecodingErrorCode" linkTitle: "TextDecodingErrorCode" description: "Used to represent an error code explaining the reason an `TextDecodingException` occurred." +weight: 1 --- # {{% param title %}} diff --git a/content/en/docs/2024.1/Reference/data-types/text/textencodingformat.md b/content/en/docs/2024.1/Reference/data-types/text/textencodingformat.md index fa5e4dcaa..3734deab7 100644 --- a/content/en/docs/2024.1/Reference/data-types/text/textencodingformat.md +++ b/content/en/docs/2024.1/Reference/data-types/text/textencodingformat.md @@ -2,6 +2,7 @@ title: "TextEncodingFormat" linkTitle: "TextEncodingFormat" description: "Used to represent formats available for encoding and decoding text." +weight: 1 --- # {{% param title %}} diff --git a/content/en/docs/2024.1/Reference/data-types/text/texttofind.md b/content/en/docs/2024.1/Reference/data-types/text/texttofind.md index b492c07e6..8ec45ad76 100644 --- a/content/en/docs/2024.1/Reference/data-types/text/texttofind.md +++ b/content/en/docs/2024.1/Reference/data-types/text/texttofind.md @@ -2,6 +2,7 @@ title: "TextToFind" linkTitle: "TextToFind" description: "Used to represent a search query for finding text." +weight: 1 --- # {{% param title %}} diff --git a/content/en/docs/2024.1/Reference/data-types/text/unicodeencoding.md b/content/en/docs/2024.1/Reference/data-types/text/unicodeencoding.md index 4fd48943e..94849a15f 100644 --- a/content/en/docs/2024.1/Reference/data-types/text/unicodeencoding.md +++ b/content/en/docs/2024.1/Reference/data-types/text/unicodeencoding.md @@ -2,30 +2,63 @@ title: "UnicodeEncoding" linkTitle: "UnicodeEncoding" description: "Used to represent Unicode character encoding." +weight: 1 --- # {{% param title %}}

(System.Text.UnicodeEncoding)

-{{< workinprogress >}} +{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}} ## Summary -## Remarks +The `UnicodeEncoding` data type is used to represent Unicode character encoding. -### Create a UnicodeEncoding +| | | +|-|-| +| **Category:** | Text | +| **Name:** | `UnicodeEncoding` | +| **Full Name:** | `System.Text.UnicodeEncoding` | +| **Alias:** | N/A | +| **Description:** | Used to represent Unicode character encoding. | +| **Default Value:** | `null` | +| **Can be used as:** | `UnicodeEncoding`, `Encoding`, `object`, `dynamic` | +| **Can be cast to:** | N/A | -### Convert UnicodeEncoding to Text +## Remarks ### Property Editor Support +- The Expression Editor is available for [Input][] properties where the data type is `UnicodeEncoding`. +- The Literal Editor is available for [Input][] properties where the data type is `UnicodeEncoding`. +- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `UnicodeEncoding`. + ### Known Limitations +None + ## See Also ### Related Data Types +- [Encoding][] +- [UTF32Encoding][] +- [UTF8Encoding][] + ### Related Concepts +None + ### External Documentation + +- [System.Text.UnicodeEncoding][UnicodeEncoding] + +[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} +[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} +[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} + +[Encoding]: {{< url path = "Cortex.Reference.DataTypes.Text.Encoding.MainDoc">}} +[UTF32Encoding]: {{< url path = "Cortex.Reference.DataTypes.Text.UTF32Encoding.MainDoc">}} +[UTF8Encoding]: {{< url path = "Cortex.Reference.DataTypes.Text.UTF8Encoding.MainDoc">}} +[UnicodeEncoding]: {{< url path = "MSDocs.DotNet.Api.System.Text.UnicodeEncoding">}} diff --git a/content/en/docs/2024.1/Reference/data-types/text/utf32encoding.md b/content/en/docs/2024.1/Reference/data-types/text/utf32encoding.md index b3d30361f..dfc87a552 100644 --- a/content/en/docs/2024.1/Reference/data-types/text/utf32encoding.md +++ b/content/en/docs/2024.1/Reference/data-types/text/utf32encoding.md @@ -2,30 +2,63 @@ title: "UTF32Encoding" linkTitle: "UTF32Encoding" description: "Used to represent UTF32 character encoding." +weight: 1 --- # {{% param title %}}

(System.Text.UTF32Encoding)

-{{< workinprogress >}} +{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}} ## Summary -## Remarks +The `UTF32Encoding` data type is used to represent UTF32 character encoding. -### Create a UTF32Encoding +| | | +|-|-| +| **Category:** | Text | +| **Name:** | `UTF32Encoding` | +| **Full Name:** | `System.Text.UTF32Encoding` | +| **Alias:** | N/A | +| **Description:** | Used to represent UTF32 character encoding. | +| **Default Value:** | `null` | +| **Can be used as:** | `UTF32Encoding`, `Encoding`, `object`, `dynamic` | +| **Can be cast to:** | N/A | -### Convert UTF32Encoding to Text +## Remarks ### Property Editor Support +- The Expression Editor is available for [Input][] properties where the data type is `UTF32Encoding`. +- The Literal Editor is available for [Input][] properties where the data type is `UTF32Encoding`. +- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `UTF32Encoding`. + ### Known Limitations +None + ## See Also ### Related Data Types +- [Encoding][] +- [UnicodeEncoding][] +- [UTF8Encoding][] + ### Related Concepts +None + ### External Documentation + +- [System.Text.UTF32Encoding][UTF32Encoding] + +[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} +[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} +[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} + +[Encoding]: {{< url path = "Cortex.Reference.DataTypes.Text.Encoding.MainDoc">}} +[UnicodeEncoding]: {{< url path = "Cortex.Reference.DataTypes.Text.UnicodeEncoding.MainDoc">}} +[UTF8Encoding]: {{< url path = "Cortex.Reference.DataTypes.Text.UTF8Encoding.MainDoc">}} +[UTF32Encoding]: {{< url path = "MSDocs.DotNet.Api.System.Text.Utf32Encoding">}} diff --git a/content/en/docs/2024.1/Reference/data-types/text/utf8encoding.md b/content/en/docs/2024.1/Reference/data-types/text/utf8encoding.md index 3a4a883a5..f26f239fe 100644 --- a/content/en/docs/2024.1/Reference/data-types/text/utf8encoding.md +++ b/content/en/docs/2024.1/Reference/data-types/text/utf8encoding.md @@ -2,30 +2,63 @@ title: "UTF8Encoding" linkTitle: "UTF8Encoding" description: "Used to represent UTF8 character encoding." +weight: 1 --- # {{% param title %}}

(System.Text.UTF8Encoding)

-{{< workinprogress >}} +{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}} ## Summary -## Remarks +The `UTF8Encoding` data type is used to represent UTF8 character encoding. -### Create a UTF8Encoding +| | | +|-|-| +| **Category:** | Text | +| **Name:** | `UTF8Encoding` | +| **Full Name:** | `System.Text.UTF8Encoding` | +| **Alias:** | N/A | +| **Description:** | Used to represent UTF8 character encoding. | +| **Default Value:** | `null` | +| **Can be used as:** | `UTF8Encoding`, `Encoding`, `object`, `dynamic` | +| **Can be cast to:** | N/A | -### Convert UTF8Encoding to Text +## Remarks ### Property Editor Support +- The Expression Editor is available for [Input][] properties where the data type is `UTF8Encoding`. +- The Literal Editor is available for [Input][] properties where the data type is `UTF8Encoding`. +- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `UTF8Encoding`. + ### Known Limitations +None + ## See Also ### Related Data Types +- [Encoding][] +- [UnicodeEncoding][] +- [UTF32Encoding][] + ### Related Concepts +None + ### External Documentation + +- [System.Text.UTF8Encoding][UTF8Encoding] + +[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} +[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} +[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} + +[Encoding]: {{< url path = "Cortex.Reference.DataTypes.Text.Encoding.MainDoc">}} +[UnicodeEncoding]: {{< url path = "Cortex.Reference.DataTypes.Text.UnicodeEncoding.MainDoc">}} +[UTF32Encoding]: {{< url path = "Cortex.Reference.DataTypes.Text.UTF32Encoding.MainDoc">}} +[UTF8Encoding]: {{< url path = "MSDocs.DotNet.Api.System.Text.Utf8Encoding">}} diff --git a/data/urls.toml b/data/urls.toml index c57023ba2..83c73d0d2 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -1541,6 +1541,8 @@ MainDoc = "/docs/reference/data-types/http/httprequestversion" HTTP10 = "/docs/reference/data-types/http/httprequestversion/#http10" HTTP11 = "/docs/reference/data-types/http/httprequestversion/#http11" + [Cortex.Reference.DataTypes.Http.HttpStatusCode] + MainDoc = "/docs/reference/data-types/http/httpstatuscode" [Cortex.Reference.DataTypes.Http.Authentication] MainDoc = "/docs/reference/data-types/http/authentication/" [Cortex.Reference.DataTypes.Http.Authentication.IHttpCredentials] @@ -2278,6 +2280,7 @@ Interpolation = "https://learn.microsoft.com/en-us/dotnet/csharp/programming-guide/strings/#string-interpolation" Verbatim = "https://learn.microsoft.com/en-us/dotnet/csharp/programming-guide/strings/#verbatim-string-literals" InterpolatedVerbatim = "https://learn.microsoft.com/en-us/dotnet/csharp/programming-guide/strings/#verbatim-string-interpolation" + SupportedCultureCodes = "https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-lcid/a9eac961-e77d-41a6-90a5-ce1a8b0cdb9c" [MSDocs.SqlServer] ErrorCodes = "https://learn.microsoft.com/en-us/sql/relational-databases/errors-events/database-engine-events-and-errors?view=sql-server-ver15" SqlException = "https://learn.microsoft.com/en-us/dotnet/api/system.data.sqlclient.sqlexception?view=dotnet-plat-ext-6.0&viewFallbackFrom=netcore-3.1" @@ -2298,7 +2301,9 @@ ArgumentNullException = "https://learn.microsoft.com/en-us/dotnet/api/system.argumentnullexception" ArgumentOutOfRangeException = "https://learn.microsoft.com/en-us/dotnet/api/system.argumentoutofrangeexception" Array = "https://learn.microsoft.com/en-us/dotnet/api/system.array" + Exception = "https://learn.microsoft.com/en-us/dotnet/api/system.exception" FormatException = "https://learn.microsoft.com/en-us/dotnet/api/system.formatexception" + IFormatProvider = "https://learn.microsoft.com/en-us/dotnet/api/system.iformatprovider" OutOfMemoryException = "https://learn.microsoft.com/en-us/dotnet/api/system.outofmemoryexception" StringComparer = "https://learn.microsoft.com/en-us/dotnet/api/system.stringcomparer" StringComparison = "https://learn.microsoft.com/en-us/dotnet/api/system.stringcomparison" @@ -2314,6 +2319,8 @@ IEnumerable_TItem = "https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1" IList = "https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.ilist-1" List = "https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1" + IReadOnlyList = "https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlylist-1" + IReadOnlyCollection = "https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlycollection-1" [MSDocs.DotNet.Api.System.Convert] MainDoc ="https://learn.microsoft.com/en-us/dotnet/api/system.convert" ToBoolean = "https://learn.microsoft.com/en-us/dotnet/api/system.convert.toboolean" @@ -2446,6 +2453,12 @@ MinValue = "https://learn.microsoft.com/en-us/dotnet/api/system.timespan.minvalue" [MSDocs.DotNet.Api.System.Globalization] CultureInfo = "https://learn.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo" + CultureInfoNotFoundException = "https://learn.microsoft.com/en-us/dotnet/api/system.globalization.culturenotfoundexception" + [MSDocs.DotNet.Api.System.Text] + Encoding = "https://learn.microsoft.com/en-us/dotnet/api/system.text.encoding" + UnicodeEncoding = "https://learn.microsoft.com/en-us/dotnet/api/system.text.unicodeencoding" + Utf8Encoding = "https://learn.microsoft.com/en-us/dotnet/api/system.text.utf8encoding" + Utf32Encoding = "https://learn.microsoft.com/en-us/dotnet/api/system.text.utf32encoding" [MSDocs.DotNet.Api.System.Text.RegularExpressions] Capture = "https://learn.microsoft.com/en-us/dotnet/api/system.text.regularexpressions.capture" Group = "https://learn.microsoft.com/en-us/dotnet/api/system.text.regularexpressions.group" @@ -2453,6 +2466,7 @@ RegexMatchTimeoutException = "https://learn.microsoft.com/en-us/dotnet/api/system.text.regularexpressions.regexmatchtimeoutexception" [MSDocs.DotNet.Api.System.Net] NetworkCredential = "https://learn.microsoft.com/en-us/dotnet/api/system.net.networkcredential" + HttpStatusCode = "https://learn.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode" [MSDocs.PowerShell] WhatIsPowerShell = "https://learn.microsoft.com/en-us/powershell/scripting/overview?view=powershell-5.1" InstallModule = "https://learn.microsoft.com/en-us/powershell/scripting/developer/module/installing-a-powershell-module?view=powershell-7.2"