NodeOPCUA API Documentation
    Preparing search index...

    Interface UACertificateExpirationAlarmEx
    namespace http://opcfoundation.org/UA/
    nodeClass ObjectType
    typedDefinition AcknowledgeableConditionType i=2881
    isAbstract false
    interface UACertificateExpirationAlarmEx {
        ackedState: UATwoStateVariableEx;
        acknowledge: UAMethod;
        activeState: UATwoStateVariableEx;
        addComment: UAMethod;
        audibleEnabled?: UAProperty<boolean, Boolean>;
        audibleSound?: UAAudioVariable<Buffer<ArrayBufferLike>>;
        branchId: UAProperty<NodeId, NodeId>;
        browseName: QualifiedName;
        certificate: UAProperty<Buffer<ArrayBufferLike>, ByteString>;
        certificateType: UAProperty<NodeId, NodeId>;
        clientUserId: UAProperty<UAString, String>;
        comment: UAConditionVariable<LocalizedText, LocalizedText>;
        conditionClassId: UAProperty<NodeId, NodeId>;
        conditionClassName: UAProperty<LocalizedText, LocalizedText>;
        conditionName: UAProperty<UAString, String>;
        conditionRefresh: UAMethod;
        conditionRefresh2: UAMethod;
        conditionSubClassId?: UAProperty<NodeId[], NodeId>;
        conditionSubClassName?: UAProperty<LocalizedText[], LocalizedText>;
        confirm?: UAMethod<UAMethodEvents>;
        confirmedState?: UATwoStateVariableEx;
        disable: UAMethod;
        enable: UAMethod;
        enabledState: UATwoStateVariableEx;
        eventId: UAProperty<Buffer<ArrayBufferLike>, ByteString>;
        eventNotifier: EventNotifierFlags;
        eventType: UAProperty<NodeId, NodeId>;
        expirationDate: UAProperty<Date, DateTime>;
        expirationLimit?: UAProperty<number, Double>;
        firstInGroup?: UAAlarmGroup;
        firstInGroupFlag?: UABaseDataVariable<boolean, Boolean>;
        getGroupMemberships?: UAMethod<UAMethodEvents>;
        hasMethods: boolean;
        inputNode: UAProperty<NodeId, NodeId>;
        lastSeverity: UAConditionVariable<number, UInt16>;
        localTime?: UAProperty<DTTimeZone, ExtensionObject>;
        maxTimeShelved?: UAProperty<number, Double>;
        message: UAProperty<LocalizedText, LocalizedText>;
        nodeClass: Object;
        nodeId: NodeId;
        normalState: UAProperty<NodeId, NodeId>;
        offDelay?: UAProperty<number, Double>;
        onDelay?: UAProperty<number, Double>;
        onFirstBrowseAction?: (this: BaseNode) => Promise<void>;
        placeInService?: UAMethod<UAMethodEvents>;
        placeInService2?: UAMethod<UAMethodEvents>;
        quality: UAConditionVariable<StatusCode, StatusCode>;
        reAlarmRepeatCount?: UABaseDataVariable<number, Int16>;
        reAlarmTime?: UAProperty<number, Double>;
        receiveTime: UAProperty<Date, DateTime>;
        removeFromService?: UAMethod<UAMethodEvents>;
        removeFromService2?: UAMethod<UAMethodEvents>;
        reset?: UAMethod<UAMethodEvents>;
        reset2?: UAMethod<UAMethodEvents>;
        retain: UAProperty<boolean, Boolean>;
        severity: UAProperty<number, UInt16>;
        silence?: UAMethod<UAMethodEvents>;
        sourceName: UAProperty<UAString, String>;
        sourceNode: UAProperty<NodeId, NodeId>;
        supportsFilteredRetain: UAProperty<boolean, Boolean>;
        suppress?: UAMethod<UAMethodEvents>;
        suppress2?: UAMethod<UAMethodEvents>;
        suppressedOrShelved: UAProperty<boolean, Boolean>;
        suppressedState?: UATwoStateVariableEx;
        time: UAProperty<Date, DateTime>;
        unsuppress?: UAMethod<UAMethodEvents>;
        unsuppress2?: UAMethod<UAMethodEvents>;
        get accessRestrictions(): AccessRestrictionsFlag | undefined;
        get addressSpace(): IAddressSpace;
        get description(): LocalizedText;
        get displayName(): LocalizedText[];
        get modellingRule(): ModellingRuleType | undefined;
        get namespace(): INamespace;
        get namespaceIndex(): number;
        get namespaceUri(): string;
        get parent(): BaseNode<BaseNodeEvents> | null;
        get parentNodeId(): NodeId | undefined;
        get rolePermissions(): RolePermissionType[] | undefined;
        get typeDefinition(): NodeId;
        get typeDefinitionObj(): UAObjectType;
        acknowledgeAndAutoConfirmBranch(
            branch: ConditionSnapshot,
            comment: LocalizedText | LocalizedTextLike,
        ): void;
        addReference(options: AddReferenceOpts): void;
        allReferences(): UAReference[];
        autoConfirmBranch(
            branch: ConditionSnapshot,
            comment: LocalizedTextLike,
        ): void;
        browseNode(
            browseDescription: BrowseDescriptionOptions2,
            session?: ISessionContext,
        ): ReferenceDescription[];
        browseNodeByTargetName(
            relativePathElement: RelativePathElement,
            isLast: boolean,
        ): NodeId[];
        clone(
            options: CloneOptions,
            optionalFilter?: CloneFilter,
            extraInfo?: CloneExtraInfo,
        ): UAObject;
        conditionOfNode(): | UAObject<UAObjectEvents>
        | UAVariable<UAVariableEvents>
        | null;
        createBranch(): ConditionSnapshot;
        currentBranch(): ConditionSnapshot;
        deleteBranch(branch: ConditionSnapshot): void;
        emit<K extends keyof UAAcknowledgeableConditionEvents>(
            event: K,
            ...args: Parameters<UAAcknowledgeableConditionEvents[K]>,
        ): boolean;
        findBranchForEventId(
            eventId: Buffer<ArrayBufferLike> | null,
        ): ConditionSnapshot | null;
        findReference(
            referenceType: string | NodeId | UAReferenceType,
            isForward?: boolean,
        ): UAReference | null;
        findReferences(
            referenceType: string | NodeId | UAReferenceType,
            isForward?: boolean,
        ): UAReference[];
        findReferencesAsObject(
            referenceType: string | NodeId | UAReferenceType,
            isForward?: boolean,
        ): BaseNode<BaseNodeEvents>[];
        findReferencesEx(
            referenceType: string | NodeId | UAReferenceType,
            browseDirection?: BrowseDirection,
        ): UAReference[];
        findReferencesExAsObject(
            referenceType: string | NodeId | UAReferenceType,
            browseDirection?: BrowseDirection,
        ): BaseNode<BaseNodeEvents>[];
        fullName(): string;
        getAccessRestrictions(inherited: boolean): AccessRestrictionsFlag;
        getAggregates(): BaseNode<BaseNodeEvents>[];
        getBranchCount(): number;
        getBranches(): ConditionSnapshot[];
        getBranchIds(): NodeId[];
        getCertificate(): DER | null;
        getChildByName(
            browseName: QualifiedNameOptions,
        ): BaseNode<BaseNodeEvents> | null;
        getChildByName(
            browseName: string,
            namespaceIndex?: number,
        ): BaseNode<BaseNodeEvents> | null;
        getComponentByName(
            componentName: QualifiedNameOptions,
        ): UAObject<UAObjectEvents> | UAVariable<UAVariableEvents> | null;
        getComponentByName(
            componentName: string,
            namespaceIndex?: number,
        ): UAObject<UAObjectEvents> | UAVariable<UAVariableEvents> | null;
        getComponents(): BaseNode<BaseNodeEvents>[];
        getDisplayName(locale?: string): string;
        getEnabledState(): boolean;
        getEnabledStateAsString(): string;
        getEventSourceOfs(): BaseNode<BaseNodeEvents>[];
        getEventSources(): BaseNode<BaseNodeEvents>[];
        getExpirationDate(): DateTime;
        getExpirationLimit(): number;
        getFolderElementByName(
            browseName: QualifiedNameOptions,
        ): BaseNode<BaseNodeEvents> | null;
        getFolderElementByName(
            browseName: string,
            namespaceIndex?: number,
        ): BaseNode<BaseNodeEvents> | null;
        getMethodById(nodeId: NodeId): UAMethod<UAMethodEvents> | null;
        getMethodByName(
            methodName: QualifiedNameOptions,
        ): UAMethod<UAMethodEvents> | null;
        getMethodByName(
            methodName: string,
            namespaceIndex?: number,
        ): UAMethod<UAMethodEvents> | null;
        getMethods(): UAMethod<UAMethodEvents>[];
        getNodeVersion(): UAProperty<UAString, String> | null;
        getNotifiers(): BaseNode<BaseNodeEvents>[];
        getProperties(): BaseNode<BaseNodeEvents>[];
        getPropertyByName(
            propertyName: QualifiedNameOptions,
        ): UAVariable<UAVariableEvents> | null;
        getPropertyByName(
            propertyName: string,
            namespaceIndex?: number,
        ): UAVariable<UAVariableEvents> | null;
        getRolePermissions(inherited: boolean): RolePermissionType[] | null;
        install_extra_properties(): void;
        isDisposed(): boolean;
        listenerCount<K extends keyof UAAcknowledgeableConditionEvents>(
            event: K,
        ): number;
        off<K extends keyof UAAcknowledgeableConditionEvents>(
            event: K,
            listener: UAAcknowledgeableConditionEvents[K],
        ): this;
        on<K extends keyof UAAcknowledgeableConditionEvents>(
            event: K,
            listener: UAAcknowledgeableConditionEvents[K],
        ): this;
        once<K extends keyof UAAcknowledgeableConditionEvents>(
            event: K,
            listener: UAAcknowledgeableConditionEvents[K],
        ): this;
        raiseConditionEvent(branch: ConditionSnapshot, renewEventId: boolean): void;
        raiseEvent(
            eventType: BaseNode<BaseNodeEvents> | EventTypeLike,
            eventData: RaiseEventData,
        ): void;
        raiseNewBranchState(branch: ConditionSnapshot): void;
        raiseNewCondition(conditionInfo: ConditionInfoOptions): void;
        readAttribute(
            context: ISessionContext | null,
            attributeId: AttributeIds,
            indexRange?: NumericRange,
            dataEncoding?: QualifiedNameLike | null,
        ): DataValue;
        removeAllListeners(): void;
        removeListener<K extends keyof UAAcknowledgeableConditionEvents>(
            event: K,
            listener: UAAcknowledgeableConditionEvents[K],
        ): void;
        removeReference(referenceOpts: AddReferenceOpts): void;
        setAccessRestrictions(accessRestrictions: AccessRestrictionsFlag): void;
        setCertificate(certificate: DER | null): void;
        setDescription(value: LocalizedTextLike | null): void;
        setDisplayName(value: LocalizedTextLike | LocalizedTextLike[]): void;
        setEnabledState(
            requestedEnabledState: boolean,
            options?: ISetStateOptions,
        ): StatusCode;
        setEventNotifier(eventNotifierFlags: EventNotifierFlags): void;
        setExpirationDate(value: Date): void;
        setExpirationLimit(value: number): void;
        setLocalTime(time: TimeZoneDataType): void;
        setMaxListeners(n: number): void;
        setReceiveTime(time: Date): void;
        setRolePermissions(rolePermissions: RolePermissionTypeOptions[]): void;
        setSourceName(name: string): void;
        setSourceNode(node: NodeId | BaseNode<BaseNodeEvents>): void;
        setTime(time: Date): void;
        update(): void;
        writeAttribute(
            context: ISessionContext | null,
            writeValue: WriteValueOptions,
            callback: (err: Error | null, statusCode?: StatusCode) => void,
        ): void;
    }

    Hierarchy (View Summary)

    • Omit<
          UACertificateExpirationAlarm_Base,
          | "ackedState"
          | "activeState"
          | "confirmedState"
          | "enabledState"
          | "latchedState"
          | "limitState"
          | "outOfServiceState"
          | "shelvingState"
          | "silenceState"
          | "suppressedState",
      >
    • UAAcknowledgeableConditionEx
      • UACertificateExpirationAlarmEx
    Index

    Properties

    ackedState acknowledge activeState addComment audibleEnabled? audibleSound? branchId browseName certificate certificateType clientUserId comment conditionClassId conditionClassName conditionName conditionRefresh conditionRefresh2 conditionSubClassId? conditionSubClassName? confirm? confirmedState? disable enable enabledState eventId eventNotifier eventType expirationDate expirationLimit? firstInGroup? firstInGroupFlag? getGroupMemberships? hasMethods inputNode lastSeverity localTime? maxTimeShelved? message nodeClass nodeId normalState offDelay? onDelay? onFirstBrowseAction? placeInService? placeInService2? quality reAlarmRepeatCount? reAlarmTime? receiveTime removeFromService? removeFromService2? reset? reset2? retain severity silence? sourceName sourceNode supportsFilteredRetain suppress? suppress2? suppressedOrShelved suppressedState? time unsuppress? unsuppress2?

    Accessors

    accessRestrictions addressSpace description displayName modellingRule namespace namespaceIndex namespaceUri parent parentNodeId rolePermissions typeDefinition typeDefinitionObj

    Methods

    acknowledgeAndAutoConfirmBranch addReference allReferences autoConfirmBranch browseNode browseNodeByTargetName clone conditionOfNode createBranch currentBranch deleteBranch emit findBranchForEventId findReference findReferences findReferencesAsObject findReferencesEx findReferencesExAsObject fullName getAccessRestrictions getAggregates getBranchCount getBranches getBranchIds getCertificate getChildByName getComponentByName getComponents getDisplayName getEnabledState getEnabledStateAsString getEventSourceOfs getEventSources getExpirationDate getExpirationLimit getFolderElementByName getMethodById getMethodByName getMethods getNodeVersion getNotifiers getProperties getPropertyByName getRolePermissions install_extra_properties isDisposed listenerCount off on once raiseConditionEvent raiseEvent raiseNewBranchState raiseNewCondition readAttribute removeAllListeners removeListener removeReference setAccessRestrictions setCertificate setDescription setDisplayName setEnabledState setEventNotifier setExpirationDate setExpirationLimit setLocalTime setMaxListeners setReceiveTime setRolePermissions setSourceName setSourceNode setTime update writeAttribute

    Properties

    ackedState: UATwoStateVariableEx
    acknowledge: UAMethod
    activeState: UATwoStateVariableEx
    addComment: UAMethod
    audibleEnabled?: UAProperty<boolean, Boolean>
    audibleSound?: UAAudioVariable<Buffer<ArrayBufferLike>>
    branchId: UAProperty<NodeId, NodeId>
    browseName: QualifiedName
    certificate: UAProperty<Buffer<ArrayBufferLike>, ByteString>
    certificateType: UAProperty<NodeId, NodeId>
    clientUserId: UAProperty<UAString, String>
    comment: UAConditionVariable<LocalizedText, LocalizedText>
    conditionClassId: UAProperty<NodeId, NodeId>
    conditionClassName: UAProperty<LocalizedText, LocalizedText>
    conditionName: UAProperty<UAString, String>
    conditionRefresh: UAMethod
    conditionRefresh2: UAMethod
    conditionSubClassId?: UAProperty<NodeId[], NodeId>
    conditionSubClassName?: UAProperty<LocalizedText[], LocalizedText>
    confirm?: UAMethod<UAMethodEvents>
    confirmedState?: UATwoStateVariableEx
    disable: UAMethod
    enable: UAMethod
    enabledState: UATwoStateVariableEx
    eventId: UAProperty<Buffer<ArrayBufferLike>, ByteString>
    eventNotifier: EventNotifierFlags
    eventType: UAProperty<NodeId, NodeId>
    expirationDate: UAProperty<Date, DateTime>
    expirationLimit?: UAProperty<number, Double>
    firstInGroup?: UAAlarmGroup
    firstInGroupFlag?: UABaseDataVariable<boolean, Boolean>
    getGroupMemberships?: UAMethod<UAMethodEvents>
    hasMethods: boolean
    inputNode: UAProperty<NodeId, NodeId>
    lastSeverity: UAConditionVariable<number, UInt16>
    localTime?: UAProperty<DTTimeZone, ExtensionObject>
    maxTimeShelved?: UAProperty<number, Double>
    message: UAProperty<LocalizedText, LocalizedText>
    nodeClass: Object
    nodeId: NodeId
    normalState: UAProperty<NodeId, NodeId>
    offDelay?: UAProperty<number, Double>
    onDelay?: UAProperty<number, Double>
    onFirstBrowseAction?: (this: BaseNode) => Promise<void>
    placeInService?: UAMethod<UAMethodEvents>
    placeInService2?: UAMethod<UAMethodEvents>
    quality: UAConditionVariable<StatusCode, StatusCode>
    reAlarmRepeatCount?: UABaseDataVariable<number, Int16>
    reAlarmTime?: UAProperty<number, Double>
    receiveTime: UAProperty<Date, DateTime>
    removeFromService?: UAMethod<UAMethodEvents>
    removeFromService2?: UAMethod<UAMethodEvents>
    reset?: UAMethod<UAMethodEvents>
    reset2?: UAMethod<UAMethodEvents>
    retain: UAProperty<boolean, Boolean>
    severity: UAProperty<number, UInt16>
    silence?: UAMethod<UAMethodEvents>
    sourceName: UAProperty<UAString, String>
    sourceNode: UAProperty<NodeId, NodeId>
    supportsFilteredRetain: UAProperty<boolean, Boolean>
    suppress?: UAMethod<UAMethodEvents>
    suppress2?: UAMethod<UAMethodEvents>
    suppressedOrShelved: UAProperty<boolean, Boolean>
    suppressedState?: UATwoStateVariableEx
    time: UAProperty<Date, DateTime>
    unsuppress?: UAMethod<UAMethodEvents>
    unsuppress2?: UAMethod<UAMethodEvents>

    Accessors

    • get accessRestrictions(): AccessRestrictionsFlag | undefined

      Returns AccessRestrictionsFlag | undefined

    • get addressSpace(): IAddressSpace

      Returns IAddressSpace

    • get description(): LocalizedText

      Returns LocalizedText

    • get displayName(): LocalizedText[]

      Returns LocalizedText[]

    • get modellingRule(): ModellingRuleType | undefined

      Returns ModellingRuleType | undefined

    • get namespace(): INamespace

      Returns INamespace

    • get namespaceIndex(): number

      Returns number

    • get namespaceUri(): string

      Returns string

    • get parentNodeId(): NodeId | undefined

      Returns NodeId | undefined

    • get rolePermissions(): RolePermissionType[] | undefined

      Returns RolePermissionType[] | undefined

    • get typeDefinition(): NodeId

      Returns NodeId

    • get typeDefinitionObj(): UAObjectType

      Returns UAObjectType

    Methods

    • find the the references that are strictly of type reference.

      The isForward boolean flag specifies the direction of the references to be looked for.

      Forward direction is implied if omitted.

      • will throw an exception if more than one reference exists with the referenceType.
      • will return null if no reference exists.

      Parameters

      Returns UAReference | null

    • find all the references that are strictly of type reference. The isForward boolean flag specifies the direction of the references to be looked for.

      Forward direction is implied if omitted.

      Parameters

      Returns UAReference[]

    • find all the nodes that are referenced by references strictly of type reference.

      The isForward boolean flag specifies the direction of the references to be looked for.

      Forward direction is implied if omitted.

      • will throw an exception if more than one reference exists with the referenceType.
      • will return null if no reference exists.

      Parameters

      Returns BaseNode<BaseNodeEvents>[]

    • return a complete name of this object by pre-pending name of its parent(s) to its own name

      Returns string

    • get effective accessRestrictions if (inherited is true) and node has no accessRestrictions, then default accessRestriction from namespace is returned if (inherited is false) and node has no accessRestrictions, then AccessRestrictionsFlag.None is returned

      Parameters

      • inherited: boolean

      Returns AccessRestrictionsFlag

    • Returns DER | null

    • Parameters

      • Optionallocale: string

        the locale of the text to return (e.g. en-EN)

      Returns string

    • Returns DateTime

    • Returns number

    • Parameters

      • certificate: DER | null

      Returns void

    • Parameters

      • requestedEnabledState: boolean
      • Optionaloptions: ISetStateOptions

      Returns StatusCode

    • Parameters

      • value: Date

      Returns void

    • Parameters

      • value: number

      Returns void

    • Parameters

      • time: Date

      Returns void

    • Parameters

      • name: string

      Returns void

    • Parameters

      • time: Date

      Returns void

    • update the status of the alarm

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    acknowledgeAndAutoConfirmBranchaddReferenceallReferencesautoConfirmBranchbrowseNodebrowseNodeByTargetNamecloneconditionOfNodecreateBranchcurrentBranchdeleteBranchemitfindBranchForEventIdfindReferencefindReferencesfindReferencesAsObjectfindReferencesExfindReferencesExAsObjectfullNamegetAccessRestrictionsgetAggregatesgetBranchCountgetBranchesgetBranchIdsgetCertificategetChildByNamegetComponentByNamegetComponentsgetDisplayNamegetEnabledStategetEnabledStateAsStringgetEventSourceOfsgetEventSourcesgetExpirationDategetExpirationLimitgetFolderElementByNamegetMethodByIdgetMethodByNamegetMethodsgetNodeVersiongetNotifiersgetPropertiesgetPropertyByNamegetRolePermissionsinstall_extra_propertiesisDisposedlistenerCountoffononceraiseConditionEventraiseEventraiseNewBranchStateraiseNewConditionreadAttributeremoveAllListenersremoveListenerremoveReferencesetAccessRestrictionssetCertificatesetDescriptionsetDisplayNamesetEnabledStatesetEventNotifiersetExpirationDatesetExpirationLimitsetLocalTimesetMaxListenerssetReceiveTimesetRolePermissionssetSourceNamesetSourceNodesetTimeupdatewriteAttribute