Class ScriptStateDatum

Records state transitions for each Script as it progresses from delivery to the user through removal from the system, either by the user completing and submitting it or deleting it without submission. This data stream in some ways parallels that of ScriptDatum, with the latter tracking data resulting from submission of the Script by the user. The ScriptStateDatum stream will be generated and submitted to the RemoteDataStore regardless of whether the user submits the Script.

Inheritance

System.Object

Datum

ScriptStateDatum

Implements

IDatum

Inherited Members

Datum.FromJSON(String)

Datum.GetJSON(AnonymizedJsonContractResolver, Boolean)

Datum.GetHashCode()

Datum.Equals(Object)

Datum.ToString()

Datum.Id

Datum.DeviceId

Datum.Timestamp

Datum.ProtocolId

Datum.Anonymized

Datum.BuildId

Datum.ParticipantId

Datum.DeviceManufacturer

Datum.DeviceModel

Datum.OperatingSystem

Datum.TaggedEventId

Datum.TaggedEventTags

Datum.SensingAgentStateDescription

Datum.LocalOffsetFromUTC

Namespace: Sensus.Probes.User.Scripts

Assembly: SensusAndroid.dll

Syntax

public class ScriptStateDatum : Datum, IDatum

Constructors

ScriptStateDatum(ScriptState, DateTimeOffset, Script)

Declaration

public ScriptStateDatum(ScriptState state, DateTimeOffset timestamp, Script script)

Parameters

Type	Name	Description
ScriptState	state
System.DateTimeOffset	timestamp
Script	script

Properties

DisplayDetail

Declaration

public override string DisplayDetail { get; }

Property Value

Type	Description
System.String

Overrides

Datum.DisplayDetail

RunId

See RunId.

Declaration

public string RunId { get; set; }

Property Value

Type	Description
System.String	The run identifier.

ScheduledTimestamp

Each Script is either triggered by another Probe or is triggered on a schedule. In the latter case, this field indicates when the Script was scheduled to run.

Declaration

public Nullable<DateTimeOffset> ScheduledTimestamp { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>	The scheduled timestamp.

ScriptId

See ScriptId.

Declaration

public string ScriptId { get; set; }

Property Value

Type	Description
System.String	The script identifier.

ScriptName

See ScriptName

Declaration

public string ScriptName { get; set; }

Property Value

Type	Description
System.String	The name of the script.

State

The ScriptState of the Script over the course of its life cycle.

Declaration

public ScriptState State { get; set; }

Property Value

Type	Description
ScriptState	The state.

StringPlaceholderValue

Gets the string placeholder value, which is always blank.

Declaration

public override object StringPlaceholderValue { get; }

Property Value

Type	Description
System.Object	The string placeholder value.

Overrides

Datum.StringPlaceholderValue

TriggerDatumId

See TriggerDatumId.

Declaration

public string TriggerDatumId { get; set; }

Property Value

Type	Description
System.String	The trigger datum identifier.

Implements

IDatum