Class ApplicationStatus

Inheritance
Object
BasePdu<ApplicationStatus>
ApplicationStatus
Inherited Members
Namespace: PKWARE.Smartcrypt.Protocol
Assembly: SmartcryptProtocol.dll
Syntax
public sealed class ApplicationStatus : BasePdu<ApplicationStatus>, IEquatable<ApplicationStatus>

Constructors

ApplicationStatus(ApplicationStatus)

Declaration
public ApplicationStatus([NotNull] ApplicationStatus other)
Parameters
Type Name Description
ApplicationStatus other

Fields

LevelCompleted

Indicates a green status.

Declaration
public const string LevelCompleted = "Completed"
Field Value
Type Description
String

LevelDone

Indicates a green status.

Declaration
public const string LevelDone = "Done"
Field Value
Type Description
String

LevelError

Indicates a red status.

Declaration
public const string LevelError = "Error"
Field Value
Type Description
String

LevelFatal

Indicates a red status.

Declaration
public const string LevelFatal = "Fatal"
Field Value
Type Description
String

LevelFinished

Indicates a green status.

Declaration
public const string LevelFinished = "Finished"
Field Value
Type Description
String

LevelInProgress

Indicates a yellow status.

Declaration
public const string LevelInProgress = "In Progress"
Field Value
Type Description
String

LevelOk

Indicates a green status.

Declaration
public const string LevelOk = "OK"
Field Value
Type Description
String

LevelWaiting

Indicates a yellow status.

Declaration
public const string LevelWaiting = "Waiting"
Field Value
Type Description
String

LevelWorking

Indicates a yellow status.

Declaration
public const string LevelWorking = "Working"
Field Value
Type Description
String

Properties

compliance

A flag indicating the client-side software's determination of whether or not it is in compliance.

Declaration
public bool compliance { get; set; }
Property Value
Type Description
Boolean

details

An optional collection of properties providing details about the status of this entry.

Declaration
public JObject details { get; set; }
Property Value
Type Description
Newtonsoft.Json.Linq.JObject

kind

The name of the software component for which this entry is being reported. For example, "Smartpoint".

Declaration
[CanBeNull]
public string kind { get; set; }
Property Value
Type Description
String

level

An optional string used to override implicit formatting in the UI derived from the "compliance" value. See the constants in this class for known values.

Declaration
[CanBeNull]
public string level { get; set; }
Property Value
Type Description
String

protocol

Optional. The application can use this to version the formula used to determine compliance. For example, version 1 of an app may have less stringent compliance requirements than version 2.

Declaration
public int protocol { get; set; }
Property Value
Type Description
Int32

qualifier

A required string indicating the exact revision that this entry refers to.

Declaration
[CanBeNull]
public string qualifier { get; set; }
Property Value
Type Description
String

refurn

A reference URN, used to differentiate entries when multiple exist for the same app + kind combo. For example, a single app may have multiple Smartpoints, so the Smartpoint URN is provided. Must be provided, but may be empty.

Declaration
[CanBeNull]
public string refurn { get; set; }
Property Value
Type Description
String

text

An optional string to override the "level". This will be shown in UIs. For example, "Waiting to Start Key Rotation", "Rotating Key", and "Key Rotated".

Declaration
[CanBeNull]
public string text { get; set; }
Property Value
Type Description
String

timestamp

The UTC time at which this entry is being reported, represented by the number of seconds elapsed since the Epoch.

Declaration
public long timestamp { get; set; }
Property Value
Type Description
Int64

version

An optional string with which the software can report the version of the component for which this entry is being reported.

Declaration
[CanBeNull]
public string version { get; set; }
Property Value
Type Description
String

Methods

ToJson(Boolean)

Declaration
protected override string ToJson(bool sending)
Parameters
Type Name Description
Boolean sending
Returns
Type Description
String
Overrides
PKWARE.Smartcrypt.Protocol.BasePdu<PKWARE.Smartcrypt.Protocol.ApplicationStatus>.ToJson(System.Boolean)

Implements