Interface IErrorBuilder

Represents an interface for building an error message

Namespace: Innovator.Client

Assembly: Innovator.Client.dll

Syntax

public interface IErrorBuilder

Methods

ErrorContext(IReadOnlyItem)

Specify the context of the error message

Declaration

IErrorBuilder ErrorContext(IReadOnlyItem item)

Parameters

Type	Name	Description
IReadOnlyItem	item	Item which the error is about

Returns

Type	Description
IErrorBuilder	The same IErrorBuilder instance for chaining additional calls

ErrorMsg(String)

Add an error message

Declaration

IErrorBuilder ErrorMsg(string message)

Parameters

Type	Name	Description
System.String	message	Message to return to the user

Returns

Type	Description
IErrorBuilder	The same IErrorBuilder instance for chaining additional calls

ErrorMsg(String, IEnumerable<String>)

Add an error message specifying the properties the message pertains to

Declaration

IErrorBuilder ErrorMsg(string message, IEnumerable<string> properties)

Parameters

Type	Name	Description
System.String	message	Message to return to the user
System.Collections.Generic.IEnumerable<System.String>	properties	Name of the properties (e.g. created_by_id) to which the error pertains

Returns

Type	Description
IErrorBuilder	The same IErrorBuilder instance for chaining additional calls

ErrorMsg(String, String[])

Add an error message specifying the properties the message pertains to

Declaration

IErrorBuilder ErrorMsg(string message, params string[] properties)

Parameters

Type	Name	Description
System.String	message	Message to return to the user
System.String[]	properties	Name of the properties (e.g. created_by_id) to which the error pertains

Returns

Type	Description
IErrorBuilder	The same IErrorBuilder instance for chaining additional calls