Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding changes to 2024.1 #117

Merged
merged 5 commits into from
Mar 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,7 +1,66 @@
---
title: "IReadOnlyList<TItem>"
linkTitle: "IReadOnlyList<TItem>"
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 %}}

{{<workinprogress>}}
<p class="namespace">(System.Collections.Generic.IReadOnlyList&lt;TItem&gt;)</p>

## 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<TItem>` |
| **Full Name:** | `System.Collections.Generic.IReadOnlyList<TItem>` |
| **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<TItem>`, `IReadOnlyCollection<TItem>`, `IEnumerable<TItem>`, `IEnumerable`, `Object`, `dynamic` |
| | `IEnumerable<TItemBaseType>` (e.g. where `IReadOnlyList<TItem>` is `IReadOnlyList<Int32>` and `IEnumerable<TItemBaseType>` is `IEnumerable<Object>` 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<TItem>`.
* The Literal Editor is not available for [Input][] properties where the data type is `IReadOnlyList<TItem>`.
* The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `IReadOnlyList<TItem>`.

### Known Limitations

None

## See Also

### Related Data Types

* [IEnumerable][]
* [IEnumerable&lt;TItem&gt;][]
* [List&lt;TItem&gt;][]

### Related Concepts

* [Working with Collections][]

### External Documentation

* [System.Collections.Generic.IReadOnlyList&lt;TItem&gt;][]
* [System.Collections.Generic.IReadOnlyCollection&lt;TItem&gt;][]

[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&lt;TItem&gt;]: {{< url path="MSDocs.DotNet.Api.System.Collections.Generic.IReadOnlyList" >}}
[System.Collections.Generic.IReadOnlyCollection&lt;TItem&gt;]: {{< url path="MSDocs.DotNet.Api.System.Collections.Generic.IReadOnlyCollection" >}}

[IEnumerable]: {{< url path="Cortex.Reference.DataTypes.Collections.IEnumerable.MainDoc" >}}
[IEnumerable&lt;TItem&gt;]: {{< url path="Cortex.Reference.DataTypes.Collections.IEnumerable_TItem.MainDoc" >}}
[List&lt;TItem&gt;]: {{< url path="Cortex.Reference.DataTypes.Collections.List.MainDoc" >}}

[Working with Collections]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Collections.MainDoc" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -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 |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,54 +8,67 @@ description: "Used to represent a component of a `DateTimeOffset` (e.g. `Year`,

<p class="namespace">(Cortex.DataTypes.DateAndTime.DateTimeComponentType)</p>

{{< 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" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -8,40 +8,53 @@ description: "Used to represent a time interval (duration of time or elapsed tim

<p class="namespace">(Cortex.DataTypes.DateAndTime.TimePeriod)</p>

{{< 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" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,55 @@ description: "Used to represent a time interval (duration of time or elapsed tim

<p class="namespace">(System.TimeSpan)</p>

{{< 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" >}}
Original file line number Diff line number Diff line change
@@ -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 %}}

<p class="namespace">(System.Exception)</p>

{{< 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" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -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][].

| | |
|--------------------|---------------------------|
Expand Down
Loading
Loading