Zum Hauptinhalt springen

CkMethodParameterDto

Namespace: Meshmakers.Octo.ConstructionKit.Contracts.DataTransferObjects

A parameter of a CkMethodDto (CK v2, AB#5669).

public class CkMethodParameterDto

Inheritance Object → CkMethodParameterDto

Properties​

Name​

The parameter name in camelCase, e.g. newPassword.

public string Name { get; set; }

Property Value​

String

ValueType​

The value type of the parameter.

public AttributeValueTypesDto ValueType { get; set; }

Property Value​

AttributeValueTypesDto

ValueCkRecordId​

The record of a AttributeValueTypesDto.Record parameter.

public CkId<CkRecordId> ValueCkRecordId { get; set; }

Property Value​

CkId<CkRecordId>

ValueCkEnumId​

The enum of an AttributeValueTypesDto.Enum parameter.

public CkId<CkEnumId> ValueCkEnumId { get; set; }

Property Value​

CkId<CkEnumId>

IsOptional​

True when the caller may omit the parameter.

public bool IsOptional { get; set; }

Property Value​

Boolean

Sensitive​

True when the value must never be logged, audited or traced (e.g. passwords).

public bool Sensitive { get; set; }

Property Value​

Boolean

Description​

An optional description of the parameter.

public string Description { get; set; }

Property Value​

String

Constructors​

CkMethodParameterDto()​

public CkMethodParameterDto()