Interface UAAcknowledgeableConditionHelper

interface UAAcknowledgeableConditionHelper {
    acknowledgeAndAutoConfirmBranch(branch: ConditionSnapshot, comment: LocalizedText | LocalizedTextLike): void;
    autoConfirmBranch(branch: ConditionSnapshot, comment: LocalizedTextLike): void;
    conditionOfNode(): null | UAObject | UAVariable;
    createBranch(): ConditionSnapshot;
    currentBranch(): ConditionSnapshot;
    deleteBranch(branch: ConditionSnapshot): void;
    getBranchCount(): number;
    getBranches(): ConditionSnapshot[];
    getBranchIds(): NodeId[];
    getEnabledState(): boolean;
    getEnabledStateAsString(): string;
    on(eventName: string, eventHandler: ((...args: any[]) => void)): this;
    on(eventName: "acknowledged" | "confirmed", eventHandler: ((eventId: null | Buffer, comment: LocalizedText, branch: ConditionSnapshot) => void)): this;
    raiseConditionEvent(branch: ConditionSnapshot, renewEventId: boolean): void;
    raiseNewBranchState(branch: ConditionSnapshot): void;
    raiseNewCondition(conditionInfo: ConditionInfoOptions): void;
    setEnabledState(requestedEnabledState: boolean, options?: ISetStateOptions): StatusCode;
    setLocalTime(time: TimeZoneDataType): void;
    setReceiveTime(time: Date): void;
    setSourceName(name: string): void;
    setSourceNode(node: NodeId | BaseNode): void;
    setTime(time: Date): void;
}

Hierarchy (view full)

Methods

acknowledgeAndAutoConfirmBranch autoConfirmBranch conditionOfNode createBranch currentBranch deleteBranch getBranchCount getBranches getBranchIds getEnabledState getEnabledStateAsString on raiseConditionEvent raiseNewBranchState raiseNewCondition setEnabledState setLocalTime setReceiveTime setSourceName setSourceNode setTime

Methods

acknowledgeAndAutoConfirmBranch

  • acknowledgeAndAutoConfirmBranch(branch, comment): void

  • Parameters

    Returns void

autoConfirmBranch

  • autoConfirmBranch(branch, comment): void

  • Parameters

    Returns void

conditionOfNode

createBranch

currentBranch

deleteBranch

  • deleteBranch(branch): void

  • Parameters

    Returns void

getBranchCount

  • getBranchCount(): number

  • Returns number

getBranches

getBranchIds

  • getBranchIds(): NodeId[]

  • Returns NodeId[]

getEnabledState

  • getEnabledState(): boolean

  • Returns boolean

getEnabledStateAsString

  • getEnabledStateAsString(): string

  • Returns string

on

  • on(eventName, eventHandler): this

  • Parameters

    • eventName: string
    • eventHandler: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    Returns this

  • on(eventName, eventHandler): this

  • Parameters

    Returns this

raiseConditionEvent

  • raiseConditionEvent(branch, renewEventId): void

  • Parameters

    Returns void

raiseNewBranchState

  • raiseNewBranchState(branch): void

  • Parameters

    Returns void

raiseNewCondition

  • raiseNewCondition(conditionInfo): void

  • Parameters

    Returns void

setEnabledState

  • setEnabledState(requestedEnabledState, options?): StatusCode

  • Parameters

    • requestedEnabledState: boolean
    • Optionaloptions: ISetStateOptions

    Returns StatusCode

setLocalTime

  • setLocalTime(time): void

  • Parameters

    Returns void

setReceiveTime

  • setReceiveTime(time): void

  • Parameters

    • time: Date

    Returns void

setSourceName

  • setSourceName(name): void

  • Parameters

    • name: string

    Returns void

setSourceNode

  • setSourceNode(node): void

  • Parameters

    Returns void

setTime

  • setTime(time): void

  • Parameters

    • time: Date

    Returns void

Settings

Member Visibility

On This Page

Methods