Skip to content

Duration Parameter

Jeremie Rossignol edited this page Jan 21, 2016 · 3 revisions

The Duration parameter sets up a timer. Once the timer expires, the parameter is completed. The timer will start when all sibling parameters that are higher than the Duration parameter in the contract are completed. The Duration parameter can also be used as a child parameter to prevent a parent parameter from completing until the duration is reached.

PARAMETER
{
    name = Duration
    type = Duration

    // The duration the timer is set to. Can specify values in years (y),
    // days (d), hours (h), minutes (m), seconds (s) or any combination of
    // those.
    //
    // Type:      Duration
    // Required:  Yes
    //
    duration = 30m 10s

    // The preWaitText sets the text that is displayed when waiting
    // for the other parameters to complete.
    //
    // Type:      string
    // Required:  Yes
    //
    preWaitText = Waiting time required

    // The waitingText sets the text that is displayed when waiting
    // for the timer to expire.
    //
    // Type:      string
    // Required:  Yes
    //
    waitingText = Time to completion

    // The completionText is displayed when the timer completes.
    //
    // Type:      string
    // Required:  Yes
    //
    completionText = Wait time over

    // The starting condition before the duration starts counting down.  If
    // PARAMETER_COMPLETION or PARAMETER_FAILURE are used, then the usual
    // behaviour of waiting for sibling parameters to be completed is
    // ignored.
    //
    // Type:      Duration.StartCriteria
    // Required:  No (defaulted)
    // Values:
    //     CONTRACT_ACCEPTANCE (default)
    //     NEXT_LAUNCH
    //     PARAMETER_COMPLETION
    //     PARAMETER_FAILURE
    //
    startCriteria = CONTRACT_ACCEPTANCE

    // If the startCriteria is set to PARAMETER_COMPLETION or PARAMETER_FAILURE,
    // the name of the parameter that must be completed to trigger the duration
    // countdown to start.
    //
    // Type:      string
    // Required:  See above (multiples allowed)
    //
    parameter = TheParameter

}
Clone this wiki locally