Class ErrorMessage

The error message table describes how we can handle custom 400-level error messages from the API on the client app.

Inheritance

System.Object

ErrorMessage

Namespace: LymeTemplateApi.Models

Assembly: LymeTemplateApi.Models.dll

Syntax

public class ErrorMessage : object

Properties

ActionText

Optional: If this value exists, a link will appear below the explanation, prompting a next course of action for the user. This value contains the text that will appear as part of the link.

Declaration

public string? ActionText { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

ActionUrlOrRoute

Optional: If this value exists, a link will appear below the explanation, prompting a next course of action for the user. This value contains the route or fully qualified URL to send the user next.

Declaration

public string? ActionUrlOrRoute { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

ErrorMessageContainsText

When a 400 message comes back from the server, the app checks this field to see if it matches a simple string of words to identify the error.

Declaration

public string ErrorMessageContainsText { get; set; }

Property Value

Type	Description
System.String

Explanation

The language that the user will see that should thoroughly explain the error message to the user and provide guidance.

Declaration

public string? Explanation { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

FullMessage

Not mapped to a database. Sends the full 400-level error message as part of the response.

Declaration

public string FullMessage { get; set; }

Property Value

Type	Description
System.String

Id

Primary Key

Declaration

public int Id { get; set; }

Property Value

Type	Description
System.Int32

Name

The short descriptive name of this Error Message handler.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

ShowErrorMessage

If this value is true, the user will see the actual 400-level error message text below the explanation.

Declaration

public bool ShowErrorMessage { get; set; }

Property Value

Type	Description
System.Boolean

SuppressMessage

If this value is true, this error message will go ignored and the user will NOT see any error messages.

Declaration

public bool SuppressMessage { get; set; }

Property Value

Type	Description
System.Boolean