Class Script

Inheritance
System.Object
Script
Implements
System.ComponentModel.INotifyPropertyChanged
System.IComparable<Script>
Namespace: Sensus.Probes.User.Scripts
Assembly: SensusAndroid.dll
Syntax
public class Script : Object, INotifyPropertyChanged, IComparable<Script>, IScript

Constructors

Script(ScriptRunner)

Declaration
public Script(ScriptRunner runner)
Parameters
Type Name Description
ScriptRunner runner

Properties

Birthdate

Gets the birthdate of the script, which is when it was first made available to the user for completion.

Declaration
public DateTime Birthdate { get; }
Property Value
Type Description
System.DateTime

The birthdate.
Remarks

The scheduled time will always be slightly before the run time, depending on latencies in the android/ios alarm/notification systems. Furthermore, on ios notifications are delivered to the tray and not to the app when the app is backgrounded. The user must open the notification in order for the script to run. In this case the scheduled time could significantly precede the run time. In any case, the scheduled time is the right thing to use as the script's birthdate. On the other hand, not all scripts are scheduled (e.g., those that are triggered by other probes). For such scripts the only thing we'll have is the run time.

Caption

Declaration
public string Caption { get; }
Property Value
Type Description
System.String

CurrentDatum

Declaration
public Datum CurrentDatum { get; set; }
Property Value
Type Description
Datum

DisplayDateTime

Declaration
public DateTime DisplayDateTime { get; }
Property Value
Type Description
System.DateTime

ExpirationDate

Declaration
public Nullable<DateTime> ExpirationDate { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

Expired

Declaration
public bool Expired { get; }
Property Value
Type Description
System.Boolean

Id

Declaration
public string Id { get; set; }
Property Value
Type Description
System.String

InputGroups

Declaration
public ObservableCollection<InputGroup> InputGroups { get; }
Property Value
Type Description
System.Collections.ObjectModel.ObservableCollection<InputGroup>

IRunner

Gets the IScriptRunner associated with the current Script (for NuGet interfacing).

Declaration
public IScriptRunner IRunner { get; }
Property Value
Type Description
IScriptRunner

The runner interface.

PreviousDatum

Declaration
public Datum PreviousDatum { get; set; }
Property Value
Type Description
Datum

Runner

Declaration
public ScriptRunner Runner { get; set; }
Property Value
Type Description
ScriptRunner

RunTime

Declaration
public Nullable<DateTimeOffset> RunTime { get; set; }
Property Value
Type Description
System.Nullable<System.DateTimeOffset>

ScheduledRunTime

Declaration
public Nullable<DateTimeOffset> ScheduledRunTime { get; set; }
Property Value
Type Description
System.Nullable<System.DateTimeOffset>

SubCaption

Declaration
public string SubCaption { get; }
Property Value
Type Description
System.String

Submitting

Declaration
public bool Submitting { get; set; }
Property Value
Type Description
System.Boolean

Valid

Gets a value indicating whether this Script is valid. A valid Script is one in which each InputGroup is Valid.

Declaration
public bool Valid { get; }
Property Value
Type Description
System.Boolean

true if valid; otherwise, false.

Methods

CompareTo(Script)

Declaration
public int CompareTo(Script script)
Parameters
Type Name Description
Script script
Returns
Type Description
System.Int32

Copy(Boolean)

Creates a copy of the current Script.

Declaration
public Script Copy(bool newId)
Parameters
Type Name Description
System.Boolean newId

If set to true, set a new random Id on the script. Doing so does not change the Id or Id values associated with this Script.
Returns
Type Description
Script

The copy.

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged
System.IComparable<>