CkMethodDto
Namespace: Meshmakers.Octo.ConstructionKit.Contracts.DataTransferObjects
A method declared on a CK type or interface (CK v2, AB#5669) — a definition only, there is no invocation runtime yet. Methods are inherited by derived and implementing types; a derived type must not re-declare an inherited method id, and a type must not redeclare an interface method with another signature.
public class CkMethodDto
Inheritance Object → CkMethodDto
Properties
MethodId
The element-versioned method id, e.g. ChangePassword-1.
public string MethodId { get; set; }
Property Value
Kind
The method kind; omitted means CkMethodKindDto.Instance.
public CkMethodKindDto Kind { get; set; }
Property Value
Description
An optional description of the method.
public string Description { get; set; }
Property Value
Parameters
The parameters of the method.
public List<CkMethodParameterDto> Parameters { get; set; }
Property Value
Result
The result of the method; null means the method has no result.
public CkMethodResultDto Result { get; set; }
Property Value
Errors
The domain error codes the method may return as data.
public List<CkMethodErrorDto> Errors { get; set; }
Property Value
Authorization
Who may invoke the method.
public CkMethodAuthorizationDto Authorization { get; set; }
Property Value
Execution
Execution options (timeout, idempotency).
public CkMethodExecutionDto Execution { get; set; }
Property Value
Visibility
CK v2 (F1.1-S4): Internal elements may only be referenced inside the declaring model. null
(omitted) means CkVisibilityDto.Public. Requires ckLanguage: 2.
public Nullable<CkVisibilityDto> Visibility { get; set; }
Property Value
Constructors
CkMethodDto()
public CkMethodDto()