> ## Documentation Index
> Fetch the complete documentation index at: https://easyaf.nimbleapps.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# PrivateObject

> This class represents the live NON public INTERNAL object in the system

## Definition

**Assembly:** CloudNimble.Breakdance.Assemblies.dll

**Namespace:** CloudNimble.Breakdance.Assemblies

**Inheritance:** System.Object

## Syntax

```csharp theme={"dark"}
CloudNimble.Breakdance.Assemblies.PrivateObject
```

## Summary

This class represents the live NON public INTERNAL object in the system

## Remarks

This type originally lived in Microsoft.VisualStudio.TestTools.UnitTesting but was removed from V2.

## Constructors

### &#x20;.ctor

Initializes a new instance of the [PrivateObject](https://easyaf.nimbleapps.cloud/breakdance/api-reference/CloudNimble/Breakdance/Assemblies/PrivateObject.md) class that contains
the already existing object of the private class

#### Syntax

```csharp theme={"dark"}
public PrivateObject(object obj, string memberToAccess)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `obj` | `object` | object that serves as starting point to reach the private members |
| `memberToAccess` | `string` | the derefrencing string using . that points to the object to be retrived as in m\_X.m\_Y.m\_Z |

### &#x20;.ctor

Initializes a new instance of the [PrivateObject](https://easyaf.nimbleapps.cloud/breakdance/api-reference/CloudNimble/Breakdance/Assemblies/PrivateObject.md) class that wraps the
specified type.

#### Syntax

```csharp theme={"dark"}
public PrivateObject(string assemblyName, string typeName, params object[] args)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `assemblyName` | `string` | Name of the assembly |
| `typeName` | `string` | fully qualified name |
| `args` | `object[]` | Argmenets to pass to the constructor |

### &#x20;.ctor

Initializes a new instance of the [PrivateObject](https://easyaf.nimbleapps.cloud/breakdance/api-reference/CloudNimble/Breakdance/Assemblies/PrivateObject.md) class that wraps the
specified type.

#### Syntax

```csharp theme={"dark"}
public PrivateObject(string assemblyName, string typeName, System.Type[] parameterTypes, object[] args)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `assemblyName` | `string` | Name of the assembly |
| `typeName` | `string` | fully qualified name |
| `parameterTypes` | `System.Type[]` | An array of [Type](https://learn.microsoft.com/dotnet/api/system.type) objects representing the number, order, and type of the parameters for the constructor to get |
| `args` | `object[]` | Arguments to pass to the constructor |

### &#x20;.ctor

Initializes a new instance of the [PrivateObject](https://easyaf.nimbleapps.cloud/breakdance/api-reference/CloudNimble/Breakdance/Assemblies/PrivateObject.md) class that wraps the
specified type.

#### Syntax

```csharp theme={"dark"}
public PrivateObject(System.Type type, params object[] args)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `type` | `System.Type` | type of the object to create |
| `args` | `object[]` | Arguments to pass to the constructor |

### &#x20;.ctor

Initializes a new instance of the [PrivateObject](https://easyaf.nimbleapps.cloud/breakdance/api-reference/CloudNimble/Breakdance/Assemblies/PrivateObject.md) class that wraps the
specified type.

#### Syntax

```csharp theme={"dark"}
public PrivateObject(System.Type type, System.Type[] parameterTypes, object[] args)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `type` | `System.Type` | type of the object to create |
| `parameterTypes` | `System.Type[]` | An array of [Type](https://learn.microsoft.com/dotnet/api/system.type) objects representing the number, order, and type of the parameters for the constructor to get |
| `args` | `object[]` | Arguments to pass to the constructor |

### &#x20;.ctor

Initializes a new instance of the [PrivateObject](https://easyaf.nimbleapps.cloud/breakdance/api-reference/CloudNimble/Breakdance/Assemblies/PrivateObject.md) class that wraps
the given object.

#### Syntax

```csharp theme={"dark"}
public PrivateObject(object obj)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `obj` | `object` | object to wrap |

### &#x20;.ctor

Initializes a new instance of the [PrivateObject](https://easyaf.nimbleapps.cloud/breakdance/api-reference/CloudNimble/Breakdance/Assemblies/PrivateObject.md) class that wraps
the given object.

#### Syntax

```csharp theme={"dark"}
public PrivateObject(object obj, CloudNimble.Breakdance.Assemblies.PrivateType type)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `obj` | `object` | object to wrap |
| `type` | `CloudNimble.Breakdance.Assemblies.PrivateType` | PrivateType object |

### &#x20;.ctor Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public Object()
```

## Properties

### &#x20;RealType

Gets the type of underlying object

#### Syntax

```csharp theme={"dark"}
public System.Type RealType { get; }
```

#### Property Value

Type: `System.Type`

### &#x20;Target

Gets or sets the target

#### Syntax

```csharp theme={"dark"}
public object Target { get; set; }
```

#### Property Value

Type: `object`

## Methods

### &#x20;Equals Override

Equals

#### Syntax

```csharp theme={"dark"}
public override bool Equals(object obj)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `obj` | `object` | Object with whom to compare |

#### Returns

Type: `bool`
returns true if the objects are equal.

### &#x20;Equals Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual bool Equals(object obj)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `obj` | `object?` | - |

#### Returns

Type: `bool`

### &#x20;Equals Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public static bool Equals(object objA, object objB)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `objA` | `object?` | - |
| `objB` | `object?` | - |

#### Returns

Type: `bool`

### &#x20;GetArrayElement

Gets the array element using array of subsrcipts for each dimension

#### Syntax

```csharp theme={"dark"}
public object GetArrayElement(string name, params int[] indices)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the member |
| `indices` | `int[]` | the indices of array |

#### Returns

Type: `object`
An arrya of elements.

### &#x20;GetArrayElement

Gets the array element using array of subsrcipts for each dimension

#### Syntax

```csharp theme={"dark"}
public object GetArrayElement(string name, System.Reflection.BindingFlags bindingFlags, params int[] indices)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the member |
| `bindingFlags` | `System.Reflection.BindingFlags` | A bitmask comprised of one or more [BindingFlags](https://learn.microsoft.com/dotnet/api/system.reflection.bindingflags) that specify how the search is conducted. |
| `indices` | `int[]` | the indices of array |

#### Returns

Type: `object`
An arrya of elements.

### &#x20;GetField

Get the field

#### Syntax

```csharp theme={"dark"}
public object GetField(string name)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the field |

#### Returns

Type: `object`
The field.

### &#x20;GetField

Gets the field

#### Syntax

```csharp theme={"dark"}
public object GetField(string name, System.Reflection.BindingFlags bindingFlags)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the field |
| `bindingFlags` | `System.Reflection.BindingFlags` | A bitmask comprised of one or more [BindingFlags](https://learn.microsoft.com/dotnet/api/system.reflection.bindingflags) that specify how the search is conducted. |

#### Returns

Type: `object`
The field.

### &#x20;GetFieldOrProperty

Get the field or property

#### Syntax

```csharp theme={"dark"}
public object GetFieldOrProperty(string name)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the field or property |

#### Returns

Type: `object`
The field or property.

### &#x20;GetFieldOrProperty

Gets the field or property

#### Syntax

```csharp theme={"dark"}
public object GetFieldOrProperty(string name, System.Reflection.BindingFlags bindingFlags)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the field or property |
| `bindingFlags` | `System.Reflection.BindingFlags` | A bitmask comprised of one or more [BindingFlags](https://learn.microsoft.com/dotnet/api/system.reflection.bindingflags) that specify how the search is conducted. |

#### Returns

Type: `object`
The field or property.

### &#x20;GetHashCode Override

returns the hash code of the target object

#### Syntax

```csharp theme={"dark"}
public override int GetHashCode()
```

#### Returns

Type: `int`
int representing hashcode of the target object

### &#x20;GetHashCode Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual int GetHashCode()
```

#### Returns

Type: `int`

### &#x20;GetProperty

Gets the property

#### Syntax

```csharp theme={"dark"}
public object GetProperty(string name, params object[] args)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the property |
| `args` | `object[]` | Arguments to pass to the member to invoke. |

#### Returns

Type: `object`
The property.

### &#x20;GetProperty

Gets the property

#### Syntax

```csharp theme={"dark"}
public object GetProperty(string name, System.Type[] parameterTypes, object[] args)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the property |
| `parameterTypes` | `System.Type[]` | An array of [Type](https://learn.microsoft.com/dotnet/api/system.type) objects representing the number, order, and type of the parameters for the indexed property. |
| `args` | `object[]` | Arguments to pass to the member to invoke. |

#### Returns

Type: `object`
The property.

### &#x20;GetProperty

Gets the property

#### Syntax

```csharp theme={"dark"}
public object GetProperty(string name, System.Reflection.BindingFlags bindingFlags, params object[] args)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the property |
| `bindingFlags` | `System.Reflection.BindingFlags` | A bitmask comprised of one or more [BindingFlags](https://learn.microsoft.com/dotnet/api/system.reflection.bindingflags) that specify how the search is conducted. |
| `args` | `object[]` | Arguments to pass to the member to invoke. |

#### Returns

Type: `object`
The property.

### &#x20;GetProperty

Gets the property

#### Syntax

```csharp theme={"dark"}
public object GetProperty(string name, System.Reflection.BindingFlags bindingFlags, System.Type[] parameterTypes, object[] args)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the property |
| `bindingFlags` | `System.Reflection.BindingFlags` | A bitmask comprised of one or more [BindingFlags](https://learn.microsoft.com/dotnet/api/system.reflection.bindingflags) that specify how the search is conducted. |
| `parameterTypes` | `System.Type[]` | An array of [Type](https://learn.microsoft.com/dotnet/api/system.type) objects representing the number, order, and type of the parameters for the indexed property. |
| `args` | `object[]` | Arguments to pass to the member to invoke. |

#### Returns

Type: `object`
The property.

### &#x20;GetType Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public System.Type GetType()
```

#### Returns

Type: `System.Type`

### &#x20;Invoke

Invokes the specified method

#### Syntax

```csharp theme={"dark"}
public object Invoke(string name, params object[] args)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the method |
| `args` | `object[]` | Arguments to pass to the member to invoke. |

#### Returns

Type: `object`
Result of method call

### &#x20;Invoke

Invokes the specified method

#### Syntax

```csharp theme={"dark"}
public object Invoke(string name, System.Type[] parameterTypes, object[] args)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the method |
| `parameterTypes` | `System.Type[]` | An array of [Type](https://learn.microsoft.com/dotnet/api/system.type) objects representing the number, order, and type of the parameters for the method to get. |
| `args` | `object[]` | Arguments to pass to the member to invoke. |

#### Returns

Type: `object`
Result of method call

### &#x20;Invoke

Invokes the specified method

#### Syntax

```csharp theme={"dark"}
public object Invoke(string name, System.Type[] parameterTypes, object[] args, System.Type[] typeArguments)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the method |
| `parameterTypes` | `System.Type[]` | An array of [Type](https://learn.microsoft.com/dotnet/api/system.type) objects representing the number, order, and type of the parameters for the method to get. |
| `args` | `object[]` | Arguments to pass to the member to invoke. |
| `typeArguments` | `System.Type[]` | An array of types corresponding to the types of the generic arguments. |

#### Returns

Type: `object`
Result of method call

### &#x20;Invoke

Invokes the specified method

#### Syntax

```csharp theme={"dark"}
public object Invoke(string name, object[] args, System.Globalization.CultureInfo culture)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the method |
| `args` | `object[]` | Arguments to pass to the member to invoke. |
| `culture` | `System.Globalization.CultureInfo` | Culture info |

#### Returns

Type: `object`
Result of method call

### &#x20;Invoke

Invokes the specified method

#### Syntax

```csharp theme={"dark"}
public object Invoke(string name, System.Type[] parameterTypes, object[] args, System.Globalization.CultureInfo culture)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the method |
| `parameterTypes` | `System.Type[]` | An array of [Type](https://learn.microsoft.com/dotnet/api/system.type) objects representing the number, order, and type of the parameters for the method to get. |
| `args` | `object[]` | Arguments to pass to the member to invoke. |
| `culture` | `System.Globalization.CultureInfo` | Culture info |

#### Returns

Type: `object`
Result of method call

### &#x20;Invoke

Invokes the specified method

#### Syntax

```csharp theme={"dark"}
public object Invoke(string name, System.Reflection.BindingFlags bindingFlags, params object[] args)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the method |
| `bindingFlags` | `System.Reflection.BindingFlags` | A bitmask comprised of one or more [BindingFlags](https://learn.microsoft.com/dotnet/api/system.reflection.bindingflags) that specify how the search is conducted. |
| `args` | `object[]` | Arguments to pass to the member to invoke. |

#### Returns

Type: `object`
Result of method call

### &#x20;Invoke

Invokes the specified method

#### Syntax

```csharp theme={"dark"}
public object Invoke(string name, System.Reflection.BindingFlags bindingFlags, System.Type[] parameterTypes, object[] args)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the method |
| `bindingFlags` | `System.Reflection.BindingFlags` | A bitmask comprised of one or more [BindingFlags](https://learn.microsoft.com/dotnet/api/system.reflection.bindingflags) that specify how the search is conducted. |
| `parameterTypes` | `System.Type[]` | An array of [Type](https://learn.microsoft.com/dotnet/api/system.type) objects representing the number, order, and type of the parameters for the method to get. |
| `args` | `object[]` | Arguments to pass to the member to invoke. |

#### Returns

Type: `object`
Result of method call

### &#x20;Invoke

Invokes the specified method

#### Syntax

```csharp theme={"dark"}
public object Invoke(string name, System.Reflection.BindingFlags bindingFlags, object[] args, System.Globalization.CultureInfo culture)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the method |
| `bindingFlags` | `System.Reflection.BindingFlags` | A bitmask comprised of one or more [BindingFlags](https://learn.microsoft.com/dotnet/api/system.reflection.bindingflags) that specify how the search is conducted. |
| `args` | `object[]` | Arguments to pass to the member to invoke. |
| `culture` | `System.Globalization.CultureInfo` | Culture info |

#### Returns

Type: `object`
Result of method call

### &#x20;Invoke

Invokes the specified method

#### Syntax

```csharp theme={"dark"}
public object Invoke(string name, System.Reflection.BindingFlags bindingFlags, System.Type[] parameterTypes, object[] args, System.Globalization.CultureInfo culture)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the method |
| `bindingFlags` | `System.Reflection.BindingFlags` | A bitmask comprised of one or more [BindingFlags](https://learn.microsoft.com/dotnet/api/system.reflection.bindingflags) that specify how the search is conducted. |
| `parameterTypes` | `System.Type[]` | An array of [Type](https://learn.microsoft.com/dotnet/api/system.type) objects representing the number, order, and type of the parameters for the method to get. |
| `args` | `object[]` | Arguments to pass to the member to invoke. |
| `culture` | `System.Globalization.CultureInfo` | Culture info |

#### Returns

Type: `object`
Result of method call

### &#x20;Invoke

Invokes the specified method

#### Syntax

```csharp theme={"dark"}
public object Invoke(string name, System.Reflection.BindingFlags bindingFlags, System.Type[] parameterTypes, object[] args, System.Globalization.CultureInfo culture, System.Type[] typeArguments)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the method |
| `bindingFlags` | `System.Reflection.BindingFlags` | A bitmask comprised of one or more [BindingFlags](https://learn.microsoft.com/dotnet/api/system.reflection.bindingflags) that specify how the search is conducted. |
| `parameterTypes` | `System.Type[]` | An array of [Type](https://learn.microsoft.com/dotnet/api/system.type) objects representing the number, order, and type of the parameters for the method to get. |
| `args` | `object[]` | Arguments to pass to the member to invoke. |
| `culture` | `System.Globalization.CultureInfo` | Culture info |
| `typeArguments` | `System.Type[]` | An array of types corresponding to the types of the generic arguments. |

#### Returns

Type: `object`
Result of method call

### &#x20;MemberwiseClone Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
protected internal object MemberwiseClone()
```

#### Returns

Type: `object`

### &#x20;ReferenceEquals Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public static bool ReferenceEquals(object objA, object objB)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `objA` | `object?` | - |
| `objB` | `object?` | - |

#### Returns

Type: `bool`

### &#x20;SetArrayElement

Sets the array element using array of subsrcipts for each dimension

#### Syntax

```csharp theme={"dark"}
public void SetArrayElement(string name, object value, params int[] indices)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the member |
| `value` | `object` | Value to set |
| `indices` | `int[]` | the indices of array |

### &#x20;SetArrayElement

Sets the array element using array of subsrcipts for each dimension

#### Syntax

```csharp theme={"dark"}
public void SetArrayElement(string name, System.Reflection.BindingFlags bindingFlags, object value, params int[] indices)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the member |
| `bindingFlags` | `System.Reflection.BindingFlags` | A bitmask comprised of one or more [BindingFlags](https://learn.microsoft.com/dotnet/api/system.reflection.bindingflags) that specify how the search is conducted. |
| `value` | `object` | Value to set |
| `indices` | `int[]` | the indices of array |

### &#x20;SetField

Sets the field

#### Syntax

```csharp theme={"dark"}
public void SetField(string name, object value)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the field |
| `value` | `object` | value to set |

### &#x20;SetField

Sets the field

#### Syntax

```csharp theme={"dark"}
public void SetField(string name, System.Reflection.BindingFlags bindingFlags, object value)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the field |
| `bindingFlags` | `System.Reflection.BindingFlags` | A bitmask comprised of one or more [BindingFlags](https://learn.microsoft.com/dotnet/api/system.reflection.bindingflags) that specify how the search is conducted. |
| `value` | `object` | value to set |

### &#x20;SetFieldOrProperty

Sets the field or property

#### Syntax

```csharp theme={"dark"}
public void SetFieldOrProperty(string name, object value)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the field or property |
| `value` | `object` | value to set |

### &#x20;SetFieldOrProperty

Sets the field or property

#### Syntax

```csharp theme={"dark"}
public void SetFieldOrProperty(string name, System.Reflection.BindingFlags bindingFlags, object value)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the field or property |
| `bindingFlags` | `System.Reflection.BindingFlags` | A bitmask comprised of one or more [BindingFlags](https://learn.microsoft.com/dotnet/api/system.reflection.bindingflags) that specify how the search is conducted. |
| `value` | `object` | value to set |

### &#x20;SetProperty

Set the property

#### Syntax

```csharp theme={"dark"}
public void SetProperty(string name, object value, params object[] args)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the property |
| `value` | `object` | value to set |
| `args` | `object[]` | Arguments to pass to the member to invoke. |

### &#x20;SetProperty

Set the property

#### Syntax

```csharp theme={"dark"}
public void SetProperty(string name, System.Type[] parameterTypes, object value, object[] args)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the property |
| `parameterTypes` | `System.Type[]` | An array of [Type](https://learn.microsoft.com/dotnet/api/system.type) objects representing the number, order, and type of the parameters for the indexed property. |
| `value` | `object` | value to set |
| `args` | `object[]` | Arguments to pass to the member to invoke. |

### &#x20;SetProperty

Sets the property

#### Syntax

```csharp theme={"dark"}
public void SetProperty(string name, System.Reflection.BindingFlags bindingFlags, object value, params object[] args)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the property |
| `bindingFlags` | `System.Reflection.BindingFlags` | A bitmask comprised of one or more [BindingFlags](https://learn.microsoft.com/dotnet/api/system.reflection.bindingflags) that specify how the search is conducted. |
| `value` | `object` | value to set |
| `args` | `object[]` | Arguments to pass to the member to invoke. |

### &#x20;SetProperty

Sets the property

#### Syntax

```csharp theme={"dark"}
public void SetProperty(string name, System.Reflection.BindingFlags bindingFlags, object value, System.Type[] parameterTypes, object[] args)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `name` | `string` | Name of the property |
| `bindingFlags` | `System.Reflection.BindingFlags` | A bitmask comprised of one or more [BindingFlags](https://learn.microsoft.com/dotnet/api/system.reflection.bindingflags) that specify how the search is conducted. |
| `value` | `object` | value to set |
| `parameterTypes` | `System.Type[]` | An array of [Type](https://learn.microsoft.com/dotnet/api/system.type) objects representing the number, order, and type of the parameters for the indexed property. |
| `args` | `object[]` | Arguments to pass to the member to invoke. |

### &#x20;ToString Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual string ToString()
```

#### Returns

Type: `string?`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.