Xecrets.Sdk.Models.XfMessage.md
May 26, 2026 · View on GitHub
Xecrets.Sdk
Xecrets.Sdk.Models
XfMessage Class
Log output and progress from the command line tool.
public class XfMessage
Inheritance System.Object → XfMessage
Properties
XfMessage.Arg1 Property
The current first argument in effect for this response, typically an 'email', 'file' or 'from' parameter.
public string? Arg1 { get; set; }
Property Value
XfMessage.Arg2 Property
The current second argument in effect for this response, typically a 'to' parameter.
public string? Arg2 { get; set; }
Property Value
XfMessage.CliApiVersion Property
The API version of the command line tool
public string? CliApiVersion { get; set; }
Property Value
XfMessage.Display Property
The current display parameter in effect for this response
public string? Display { get; set; }
Property Value
XfMessage.Id Property
The current id value parameter in effect for this response
public string? Id { get; set; }
Property Value
XfMessage.Message Property
The display message associated with the command response.
public string? Message { get; set; }
Property Value
XfMessage.OpCode Property
The current Xecrets.Sdk.Models.XfOpCode for this response.
public int OpCode { get; set; }
Property Value
XfMessage.OpCodeName Property
The name of the Xecrets.Sdk.Models.XfOpCode for this response.
public string? OpCodeName { get; set; }
Property Value
XfMessage.OriginalFileName Property
The original file name in effect for this response.
public string? OriginalFileName { get; set; }
Property Value
XfMessage.Percent Property
The completion percentage in progress of this invocation of the command line tool.
public int Percent { get; set; }
Property Value
XfMessage.Platform Property
The platform this command line tool is built for and running on.
public string? Platform { get; set; }
Property Value
XfMessage.ProgramVersion Property
The full program version of the command line tool.
public string? ProgramVersion { get; set; }
Property Value
XfMessage.Result Property
The full path name of the result of the operation of this response.
public string? Result { get; set; }
Property Value
XfMessage.Status Property
The status of the current operation as an integer.
public int Status { get; set; }
Property Value
XfMessage.StatusName Property
The name of the status of the current operation as string.
public string? StatusName { get; set; }
Property Value
XfMessage.SubStatus Property
The sub status of the current operation as an integer.
public int SubStatus { get; set; }
Property Value
XfMessage.TotalDone Property
Number of bytes of the total that have been processed in progress.
public long TotalDone { get; set; }
Property Value
XfMessage.TotalPercent Property
The percentage of total work that has been processed in progress.
public int TotalPercent { get; set; }
Property Value
XfMessage.TotalWork Property
The total work that is to be done by this command line tool invocation.
public long TotalWork { get; set; }
Property Value
XfMessage.Utc Property
The date and time of the log message, UTC.
public System.DateTime Utc { get; set; }