SendResultクラス - automatic9045/TRS.MS-12 GitHub Wiki

回答を表すクラスです。

public class SendResult

基本情報

名前空間   TRS.TMS12.Interfaces
アセンブリ  MS-12.PluginHost.dll
継承     Object → SendResult
派生     TRS.TMS12.Interfaces.IssuableSendResult
       TRS.TMS12.Interfaces.IssueReservableSendResult

プロパティ

bool IsFullScreen { get; set; } = false;

回答を全画面で表示するかを取得・設定します。

SendResultType? Result { get; set; } = null;

回答の種別(YES・NO・再考)を取得・設定します。

備考

発信中に障害が発生し、回答のタイプが特定出来ない場合は null を設定します。

string RethinkCode { get; set; } = "";

再考回答の理由を表すコードを取得・設定します。
再考コードは半角カナ 2 字 + 半角数字 4 桁で表されます。

string Message { get; set; } = "";

回答の理由や備考を説明するメッセージを取得・設定します。

例1.再考回答の理由を表示

sendResult.Message = "要求区間誤り";

例2.一件操作外で予約発信されたため、自動的に一括一件を開始したときの表示

sendResult.Message = "一括一件開始しました";

string Text { get; set; } = "";

回答の詳細を説明するテキストを取得・設定します。

string RawString { get; set; } = "";

中央サーバーから回答された生電文などを取得・設定します。

Exception プロパティが設定されている場合、障害メッセージダイアログにこのプロパティの値が表示されます。
値の設定は必須ではありませんが、回答は得られたものの SendResult への加工中に障害が発生したときの原因究明に役立ちます。

Exception Exception { get; set; } = null;

発信時に発生した例外を取得・設定します。
このプロパティが設定されている場合、障害メッセージダイアログが表示されます。

メソッド

static SendResult Yes(string text, string message, bool isFullScreen);

YESの SendResult を作成します。

パラメーター

text string

回答の詳細を説明するテキスト。

message string

回答の理由や備考を説明するメッセージ。

isFullScreen bool

回答を全画面で表示するか。

static SendResult No(string text, string message = "");

NOの SendResult を作成します。

パラメーター

text string

回答の詳細を説明するテキスト。

message string

回答の理由や備考を説明するメッセージ。

static SendResult Rethink(string message = "", string rethinkCode = "??0000");

再考の SendResult を作成します。

message string

回答の理由や備考を説明するメッセージ。

rethinkCode string

再考回答の理由を表すコード。
再考コードは半角カナ 2 字 + 半角数字 4 桁で表されます。

static SendResult Error(Exception exception, string rawString = "", SendResultType? type = null);

障害が発生したことを表す SendResult を作成します。

exception Exception

発信時に発生した例外。

rawString string

中央サーバーから回答された生電文など。
値の設定は必須ではありませんが、回答は得られたものの SendResult への加工中に障害が発生したときの原因究明に役立ちます。

type SendResultType?

回答の種別(YES・NO・再考)。
発信中に障害が発生し、回答のタイプが特定出来ない場合は null を設定します。