Struct EmsError

Object containing any _errors or messages from the EMS regarding the EMS request it was used on.

Inherited Members
System.ValueType.Equals(System.Object)
System.ValueType.GetHashCode()
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Appearition.Common
Assembly: Appearition.SDK.dll
Syntax
public struct EmsError

Constructors

View Source

EmsError(IEnumerable<String>, Int32)

Declaration
public EmsError(IEnumerable<string> newErrors, int newErrorCode = 0)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.String> newErrors
System.Int32 newErrorCode
View Source

EmsError(String, Int32)

Declaration
public EmsError(string newError, int newErrorCode = 0)
Parameters
Type Name Description
System.String newError
System.Int32 newErrorCode

Fields

View Source

errorCode

Declaration
public int errorCode
Field Value
Type Description
System.Int32
View Source

Errors

Contains all the _errors and messages from the EMS that occured during this request.

Declaration
public List<string> Errors
Field Value
Type Description
System.Collections.Generic.List<System.String>

Properties

View Source

HasErrors

Returns whether or not any _errors happened during the EMS request.

Declaration
public bool HasErrors { get; }
Property Value
Type Description
System.Boolean

true if has _errors; otherwise, false.
View Source

IsAuthenticationError

Whether the error is caused by low authentication level. Often, this happens when a user token has been expired, and the user should be prompted to login again.

Declaration
public bool IsAuthenticationError { get; }
Property Value
Type Description
System.Boolean
View Source

IsErrorLocal

Whether the error occured without the EMS getting involved.

Declaration
public bool IsErrorLocal { get; }
Property Value
Type Description
System.Boolean
View Source

IsMarkedAsSuccessful

Whether the error is caused by unexpected data outcome despite the request being successful.

Declaration
public bool IsMarkedAsSuccessful { get; }
Property Value
Type Description
System.Boolean
View Source

IsRequestNotFound

Whether the request hasn't found a valid end point.

Declaration
public bool IsRequestNotFound { get; }
Property Value
Type Description
System.Boolean
View Source

IsServerError

Whether the error is caused by an internal server error. Do note that unexpected request content may cause this outcome.

Declaration
public bool IsServerError { get; }
Property Value
Type Description
System.Boolean

Methods

View Source

ResetToDefault()

Resets this error container to a blank default state.

Declaration
public void ResetToDefault()
View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.ValueType.ToString()

Extension Methods