Struct IssueHandlingRequest

A data structure that contains all the information needed to display and handle an issue that the user needs to handle

Namespace: Unity.MARS.Companion.Core

Syntax

public struct IssueHandlingRequest

Constructors

IssueHandlingRequest(String, IssueDialogSettings, IssueHandledCallback, Boolean)

Constructor for creating an issue handling request.

Declaration

public IssueHandlingRequest(string issueCode, IssueDialogSettings settings, IssueHandledCallback handledCallback = null, bool toggleCurrentStatus = false)

Parameters

Type	Name	Description
String	issueCode	The code for this issue
IssueDialogSettings	settings	The settings data structure.
IssueHandledCallback	handledCallback	The handled callback, which can be null.
Boolean	toggleCurrentStatus	The current toggle status for toggle dialogs, ignored if this isn't a toggle dialog.

Fields

Exception

If this issue represents an exception that needs user handling or to inform the user of a critical error, this should contain the caught exception for logging / further handling.

Declaration

public readonly Exception Exception

Field Value

Type	Description
Exception

HandledCallback

An optional callback if we need to handle the result of the user's decision (if it's not just an information text box)

Declaration

public readonly IssueHandledCallback HandledCallback

Field Value

Type	Description
IssueHandledCallback

IssueCode

The issue code for this request

Declaration

public readonly string IssueCode

Field Value

Type	Description
String

Settings

The settings that control what is displayed to the user via a dialog box.

Declaration

public readonly IssueDialogSettings Settings

Field Value

Type	Description
IssueDialogSettings

ToggleCurrentStatus

If using the toggle change feature of the dialog box, this should be set to the current value.

Declaration

public readonly bool ToggleCurrentStatus

Field Value

Type	Description
Boolean