Interface UACertificateExpirationAlarm


namespace	http://opcfoundation.org/UA/
nodeClass	ObjectType
typedDefinition	AlarmConditionType i=2915
isAbstract	false

interface UACertificateExpirationAlarm {
    accessRestrictions: AccessRestrictionsFlag | undefined;
    ackedState: UATwoStateVariable<LocalizedText>;
    acknowledge: UAMethod;
    activeState: UATwoStateVariable<LocalizedText>;
    addComment: UAMethod;
    addressSpace: IAddressSpace;
    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?: UATwoStateVariable<LocalizedText>;
    description: LocalizedText;
    disable: UAMethod;
    displayName: LocalizedText[];
    enable: UAMethod;
    enabledState: UATwoStateVariable<LocalizedText>;
    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>;
    latchedState?: UATwoStateVariable<LocalizedText>;
    localTime?: UAProperty<DTTimeZone, ExtensionObject>;
    maxTimeShelved?: UAProperty<number, Double>;
    message: UAProperty<LocalizedText, LocalizedText>;
    modellingRule: ModellingRuleType | undefined;
    namespace: INamespace;
    namespaceIndex: number;
    namespaceUri: string;
    nodeClass: Object;
    nodeId: NodeId;
    normalState: UAProperty<NodeId, NodeId>;
    offDelay?: UAProperty<number, Double>;
    onDelay?: UAProperty<number, Double>;
    onFirstBrowseAction?: (this: BaseNode) => Promise<void>;
    outOfServiceState?: UATwoStateVariable<LocalizedText>;
    parent: BaseNode<BaseNodeEvents> | null;
    parentNodeId: NodeId | undefined;
    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>;
    rolePermissions: RolePermissionType[] | undefined;
    severity: UAProperty<number, UInt16>;
    shelvingState?: UAShelvedStateMachine;
    silence?: UAMethod<UAMethodEvents>;
    silenceState?: UATwoStateVariable<LocalizedText>;
    sourceName: UAProperty<UAString, String>;
    sourceNode: UAProperty<NodeId, NodeId>;
    supportsFilteredRetain: UAProperty<boolean, Boolean>;
    suppress?: UAMethod<UAMethodEvents>;
    suppress2?: UAMethod<UAMethodEvents>;
    suppressedOrShelved: UAProperty<boolean, Boolean>;
    suppressedState?: UATwoStateVariable<LocalizedText>;
    time: UAProperty<Date, DateTime>;
    typeDefinition: NodeId;
    typeDefinitionObj: UAObjectType;
    unsuppress?: UAMethod<UAMethodEvents>;
    unsuppress2?: UAMethod<UAMethodEvents>;
    addReference(options: AddReferenceOpts): void;
    allReferences(): UAReference[];
    browseNode(
        browseDescription: BrowseDescriptionOptions2,
        session?: ISessionContext,
    ): ReferenceDescription[];
    browseNodeByTargetName(
        relativePathElement: RelativePathElement,
        isLast: boolean,
    ): NodeId[];
    clone(
        options: CloneOptions,
        optionalFilter?: CloneFilter,
        extraInfo?: CloneExtraInfo,
    ): UAObject;
    emit<K extends keyof UAObjectEvents>(
        event: K,
        ...args: Parameters<UAObjectEvents[K]>,
    ): boolean;
    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>[];
    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;
    getEventSourceOfs(): BaseNode<BaseNodeEvents>[];
    getEventSources(): BaseNode<BaseNodeEvents>[];
    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 UAObjectEvents>(event: K): number;
    off<K extends keyof UAObjectEvents>(
        event: K,
        listener: UAObjectEvents[K],
    ): this;
    on<K extends keyof UAObjectEvents>(
        event: K,
        listener: UAObjectEvents[K],
    ): this;
    once<K extends keyof UAObjectEvents>(
        event: K,
        listener: UAObjectEvents[K],
    ): this;
    raiseEvent(
        eventType: BaseNode<BaseNodeEvents> | EventTypeLike,
        eventData: RaiseEventData,
    ): void;
    readAttribute(
        context: ISessionContext | null,
        attributeId: AttributeIds,
        indexRange?: NumericRange,
        dataEncoding?: QualifiedNameLike | null,
    ): DataValue;
    removeAllListeners(): void;
    removeListener<K extends keyof UAObjectEvents>(
        event: K,
        listener: UAObjectEvents[K],
    ): void;
    removeReference(referenceOpts: AddReferenceOpts): void;
    setAccessRestrictions(accessRestrictions: AccessRestrictionsFlag): void;
    setDescription(value: LocalizedTextLike | null): void;
    setDisplayName(value: LocalizedTextLike | LocalizedTextLike[]): void;
    setEventNotifier(eventNotifierFlags: EventNotifierFlags): void;
    setMaxListeners(n: number): void;
    setRolePermissions(rolePermissions: RolePermissionTypeOptions[]): void;
    writeAttribute(
        context: ISessionContext | null,
        writeValue: WriteValueOptions,
        callback: (err: Error | null, statusCode?: StatusCode) => void,
    ): void;
}

Hierarchy (View Summary)

UASystemOffNormalAlarm
UACertificateExpirationAlarm_Base
- UACertificateExpirationAlarm

Index

Properties

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

Properties

accessRestrictions

accessRestrictions: AccessRestrictionsFlag | undefined

ackedState

ackedState: UATwoStateVariable<LocalizedText>

acknowledge

acknowledge: UAMethod

activeState

activeState: UATwoStateVariable<LocalizedText>

addComment

addComment: UAMethod

addressSpace

addressSpace: IAddressSpace

`Optional`audibleEnabled

audibleEnabled?: UAProperty<boolean, Boolean>

`Optional`audibleSound

audibleSound?: UAAudioVariable<Buffer<ArrayBufferLike>>

branchId

branchId: UAProperty<NodeId, NodeId>

`Readonly`browseName

browseName: QualifiedName

certificate

certificate: UAProperty<Buffer<ArrayBufferLike>, ByteString>

conditionRefresh

conditionRefresh: UAMethod

conditionRefresh2

conditionRefresh2: UAMethod

`Optional`conditionSubClassId

conditionSubClassId?: UAProperty<NodeId[], NodeId>

`Optional`conditionSubClassName

conditionSubClassName?: UAProperty<LocalizedText[], LocalizedText>

`Optional`confirm

confirm?: UAMethod<UAMethodEvents>

`Optional`confirmedState

confirmedState?: UATwoStateVariable<LocalizedText>

description

description: LocalizedText

disable

disable: UAMethod

displayName

displayName: LocalizedText[]

enable

enable: UAMethod

enabledState

enabledState: UATwoStateVariable<LocalizedText>

eventId

eventId: UAProperty<Buffer<ArrayBufferLike>, ByteString>

`Readonly`eventNotifier

eventNotifier: EventNotifierFlags

eventType

eventType: UAProperty<NodeId, NodeId>

expirationDate

expirationDate: UAProperty<Date, DateTime>

`Optional`expirationLimit

expirationLimit?: UAProperty<number, Double>

`Optional`firstInGroup

firstInGroup?: UAAlarmGroup

`Optional`firstInGroupFlag

firstInGroupFlag?: UABaseDataVariable<boolean, Boolean>

`Optional`getGroupMemberships

getGroupMemberships?: UAMethod<UAMethodEvents>

`Readonly`hasMethods

hasMethods: boolean

inputNode

inputNode: UAProperty<NodeId, NodeId>

lastSeverity

lastSeverity: UAConditionVariable<number, UInt16>

`Optional`latchedState

latchedState?: UATwoStateVariable<LocalizedText>

`Optional`localTime

localTime?: UAProperty<DTTimeZone, ExtensionObject>

`Optional`maxTimeShelved

maxTimeShelved?: UAProperty<number, Double>

message

message: UAProperty<LocalizedText, LocalizedText>

modellingRule

modellingRule: ModellingRuleType | undefined

namespace

namespace: INamespace

namespaceIndex

namespaceIndex: number

namespaceUri

namespaceUri: string

`Readonly`nodeClass

nodeClass: Object

`Readonly`nodeId

nodeId: NodeId

normalState

normalState: UAProperty<NodeId, NodeId>

`Optional`offDelay

offDelay?: UAProperty<number, Double>

`Optional`onDelay

onDelay?: UAProperty<number, Double>

`Optional`onFirstBrowseAction

onFirstBrowseAction?: (this: BaseNode) => Promise<void>

`Optional`outOfServiceState

outOfServiceState?: UATwoStateVariable<LocalizedText>

parent

parent: BaseNode<BaseNodeEvents> | null

parentNodeId

parentNodeId: NodeId | undefined

`Optional`placeInService

placeInService?: UAMethod<UAMethodEvents>

`Optional`placeInService2

placeInService2?: UAMethod<UAMethodEvents>

quality

quality: UAConditionVariable<StatusCode, StatusCode>

`Optional`reAlarmRepeatCount

reAlarmRepeatCount?: UABaseDataVariable<number, Int16>

`Optional`reAlarmTime

reAlarmTime?: UAProperty<number, Double>

receiveTime

receiveTime: UAProperty<Date, DateTime>

`Optional`removeFromService

removeFromService?: UAMethod<UAMethodEvents>

`Optional`removeFromService2

removeFromService2?: UAMethod<UAMethodEvents>

`Optional`reset

reset?: UAMethod<UAMethodEvents>

`Optional`reset2

reset2?: UAMethod<UAMethodEvents>

retain

retain: UAProperty<boolean, Boolean>

rolePermissions

rolePermissions: RolePermissionType[] | undefined

severity

severity: UAProperty<number, UInt16>

`Optional`shelvingState

shelvingState?: UAShelvedStateMachine

`Optional`silence

silence?: UAMethod<UAMethodEvents>

`Optional`silenceState

silenceState?: UATwoStateVariable<LocalizedText>

sourceName

sourceName: UAProperty<UAString, String>

sourceNode

sourceNode: UAProperty<NodeId, NodeId>

supportsFilteredRetain

supportsFilteredRetain: UAProperty<boolean, Boolean>

`Optional`suppress

suppress?: UAMethod<UAMethodEvents>

`Optional`suppress2

suppress2?: UAMethod<UAMethodEvents>

suppressedOrShelved

suppressedOrShelved: UAProperty<boolean, Boolean>

`Optional`suppressedState

suppressedState?: UATwoStateVariable<LocalizedText>

time

time: UAProperty<Date, DateTime>

typeDefinition

typeDefinition: NodeId

typeDefinitionObj

typeDefinitionObj: UAObjectType

`Optional`unsuppress

unsuppress?: UAMethod<UAMethodEvents>

`Optional`unsuppress2

unsuppress2?: UAMethod<UAMethodEvents>

Methods

addReference

addReference(options: AddReferenceOpts): void
Parameters
- options: AddReferenceOpts
Returns void
Inherited from UASystemOffNormalAlarm.addReference
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:113

allReferences

allReferences(): UAReference[]
Returns UAReference[]
Inherited from UASystemOffNormalAlarm.allReferences
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:180

browseNode

browseNode(
browseDescription: BrowseDescriptionOptions2,
session?: ISessionContext,
): ReferenceDescription[]
browse the node to extract information requested in browseDescription
Parameters
- browseDescription: BrowseDescriptionOptions2
- Optionalsession: ISessionContext
Returns ReferenceDescription[]
Inherited from UASystemOffNormalAlarm.browseNode
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:199

browseNodeByTargetName

browseNodeByTargetName(
relativePathElement: RelativePathElement,
isLast: boolean,
): NodeId[]
Parameters
- relativePathElement: RelativePathElement
- isLast: boolean
Returns NodeId[]
Inherited from UASystemOffNormalAlarm.browseNodeByTargetName
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:136

clone

clone(
    options: CloneOptions,
    optionalFilter?: CloneFilter,
    extraInfo?: CloneExtraInfo,
): UAObject
Parameters
- options: CloneOptions
- OptionaloptionalFilter: CloneFilter
- OptionalextraInfo: CloneExtraInfo
Returns UAObject
Inherited from UASystemOffNormalAlarm.clone
- Defined in packages/node-opcua-address-space-base/dist/ua_object.d.ts:134

emit

emit<K extends keyof UAObjectEvents>(
event: K,
...args: Parameters<UAObjectEvents[K]>,
): boolean
Type Parameters
- K extends keyof UAObjectEvents
Parameters
- event: K
- ...args: Parameters<UAObjectEvents[K]>
Returns boolean
Inherited from UASystemOffNormalAlarm.emit
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:81

findReference

findReference(
referenceType: string | NodeId | UAReferenceType,
isForward?: boolean,
): UAReference | null
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
- referenceType: string | NodeId | UAReferenceType
- OptionalisForward: boolean
Returns UAReference | null
Inherited from UASystemOffNormalAlarm.findReference
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:161

findReferences

findReferences(
referenceType: string | NodeId | UAReferenceType,
isForward?: boolean,
): UAReference[]
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
- referenceType: string | NodeId | UAReferenceType
- OptionalisForward: boolean
Returns UAReference[]
Inherited from UASystemOffNormalAlarm.findReferences
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:150

findReferencesAsObject

findReferencesAsObject(
referenceType: string | NodeId | UAReferenceType,
isForward?: boolean,
): BaseNode<BaseNodeEvents>[]
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
- referenceType: string | NodeId | UAReferenceType
- OptionalisForward: boolean
Returns BaseNode<BaseNodeEvents>[]
Inherited from UASystemOffNormalAlarm.findReferencesAsObject
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:179

findReferencesEx

findReferencesEx(
referenceType: string | NodeId | UAReferenceType,
browseDirection?: BrowseDirection,
): UAReference[]
find all the references that are of type reference or a sub type of reference, in the direction specified by browseDirection
- BrowseDirection.Forward direction is implied if browseDirection flags is omitted.
Parameters
- referenceType: string | NodeId | UAReferenceType
- OptionalbrowseDirection: BrowseDirection
Returns UAReference[]
Inherited from UASystemOffNormalAlarm.findReferencesEx
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:143

findReferencesExAsObject

findReferencesExAsObject(
referenceType: string | NodeId | UAReferenceType,
browseDirection?: BrowseDirection,
): BaseNode<BaseNodeEvents>[]
find all the nodes that are referenced by references of type reference or a sub type of reference, in the direction specified by browseDirection
- BrowseDirection.Forward direction is implied if browseDirection flags is omitted.
Parameters
- referenceType: string | NodeId | UAReferenceType
- OptionalbrowseDirection: BrowseDirection
Returns BaseNode<BaseNodeEvents>[]
Inherited from UASystemOffNormalAlarm.findReferencesExAsObject
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:168

fullName

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

Returns string
Inherited from UASystemOffNormalAlarm.fullName
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:112

getAccessRestrictions

getAccessRestrictions(inherited: boolean): AccessRestrictionsFlag
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
Inherited from UASystemOffNormalAlarm.getAccessRestrictions
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:218

getAggregates

getAggregates(): BaseNode<BaseNodeEvents>[]
Returns BaseNode<BaseNodeEvents>[]
Inherited from UASystemOffNormalAlarm.getAggregates
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:237

getChildByName

getChildByName(
browseName: QualifiedNameOptions,
): BaseNode<BaseNodeEvents> | null
Get the Child by name, if browseName is string and namespaceIndex undefined then the search doesn't care about namespace matching
Parameters
- browseName: QualifiedNameOptions
Returns BaseNode<BaseNodeEvents> | null
Inherited from UASystemOffNormalAlarm.getChildByName
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:187
getChildByName(
browseName: string,
namespaceIndex?: number,
): BaseNode<BaseNodeEvents> | null
Parameters
- browseName: string
- OptionalnamespaceIndex: number
Returns BaseNode<BaseNodeEvents> | null
Inherited from UASystemOffNormalAlarm.getChildByName
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:188

getComponentByName

getComponentByName(
componentName: QualifiedNameOptions,
): UAObject<UAObjectEvents> | UAVariable<UAVariableEvents> | null
Parameters
- componentName: QualifiedNameOptions
Returns UAObject<UAObjectEvents> | UAVariable<UAVariableEvents> | null
Inherited from IPropertyAndComponentHolder.getComponentByName
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:38
getComponentByName(
componentName: string,
namespaceIndex?: number,
): UAObject<UAObjectEvents> | UAVariable<UAVariableEvents> | null
Parameters
- componentName: string
- OptionalnamespaceIndex: number
Returns UAObject<UAObjectEvents> | UAVariable<UAVariableEvents> | null
Inherited from IPropertyAndComponentHolder.getComponentByName
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:39

getComponents

getComponents(): BaseNode<BaseNodeEvents>[]
Returns BaseNode<BaseNodeEvents>[]
Inherited from IPropertyAndComponentHolder.getComponents
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:43

getDisplayName

getDisplayName(locale?: string): string
Parameters
- Optionallocale: string
  the locale of the text to return (e.g. en-EN)
Returns string
Inherited from UASystemOffNormalAlarm.getDisplayName
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:131

getEventSourceOfs

getEventSourceOfs(): BaseNode<BaseNodeEvents>[]
return a array of the objects for which this node is an EventSource nodes = HasEventSource => self

Returns BaseNode<BaseNodeEvents>[]
Inherited from UASystemOffNormalAlarm.getEventSourceOfs
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:126

getEventSources

getEventSources(): BaseNode<BaseNodeEvents>[]
return a array with the event source of this object. self = HasEventSource => nodes

Returns BaseNode<BaseNodeEvents>[]
Inherited from UASystemOffNormalAlarm.getEventSources
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:121

getFolderElementByName

getFolderElementByName(
browseName: QualifiedNameOptions,
): BaseNode<BaseNodeEvents> | null
Parameters
- browseName: QualifiedNameOptions
Returns BaseNode<BaseNodeEvents> | null
Inherited from UASystemOffNormalAlarm.getFolderElementByName
- Defined in packages/node-opcua-address-space-base/dist/ua_object.d.ts:126
getFolderElementByName(
browseName: string,
namespaceIndex?: number,
): BaseNode<BaseNodeEvents> | null
Parameters
- browseName: string
- OptionalnamespaceIndex: number
Returns BaseNode<BaseNodeEvents> | null
Inherited from UASystemOffNormalAlarm.getFolderElementByName
- Defined in packages/node-opcua-address-space-base/dist/ua_object.d.ts:127

getMethodById

getMethodById(nodeId: NodeId): UAMethod<UAMethodEvents> | null
Parameters
- nodeId: NodeId
Returns UAMethod<UAMethodEvents> | null
Inherited from UASystemOffNormalAlarm.getMethodById
- Defined in packages/node-opcua-address-space-base/dist/ua_object.d.ts:128

getMethodByName

getMethodByName(
methodName: QualifiedNameOptions,
): UAMethod<UAMethodEvents> | null
Parameters
- methodName: QualifiedNameOptions
Returns UAMethod<UAMethodEvents> | null
Inherited from UASystemOffNormalAlarm.getMethodByName
- Defined in packages/node-opcua-address-space-base/dist/ua_object.d.ts:129
getMethodByName(
methodName: string,
namespaceIndex?: number,
): UAMethod<UAMethodEvents> | null
Parameters
- methodName: string
- OptionalnamespaceIndex: number
Returns UAMethod<UAMethodEvents> | null
Inherited from UASystemOffNormalAlarm.getMethodByName
- Defined in packages/node-opcua-address-space-base/dist/ua_object.d.ts:130

getMethods

getMethods(): UAMethod<UAMethodEvents>[]
Returns UAMethod<UAMethodEvents>[]
Inherited from UASystemOffNormalAlarm.getMethods
- Defined in packages/node-opcua-address-space-base/dist/ua_object.d.ts:131

getNodeVersion

getNodeVersion(): UAProperty<UAString, String> | null
return the versioning node

Returns UAProperty<UAString, String> | null
Inherited from UASystemOffNormalAlarm.getNodeVersion
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:233

getNotifiers

getNotifiers(): BaseNode<BaseNodeEvents>[]
Returns BaseNode<BaseNodeEvents>[]
Inherited from IPropertyAndComponentHolder.getNotifiers
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:45

getProperties

getProperties(): BaseNode<BaseNodeEvents>[]
Returns BaseNode<BaseNodeEvents>[]
Inherited from IPropertyAndComponentHolder.getProperties
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:44

getPropertyByName

getPropertyByName(
propertyName: QualifiedNameOptions,
): UAVariable<UAVariableEvents> | null
Parameters
- propertyName: QualifiedNameOptions
Returns UAVariable<UAVariableEvents> | null
Inherited from IPropertyAndComponentHolder.getPropertyByName
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:40
getPropertyByName(
propertyName: string,
namespaceIndex?: number,
): UAVariable<UAVariableEvents> | null
Parameters
- propertyName: string
- OptionalnamespaceIndex: number
Returns UAVariable<UAVariableEvents> | null
Inherited from IPropertyAndComponentHolder.getPropertyByName
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:41

getRolePermissions

getRolePermissions(inherited: boolean): RolePermissionType[] | null
Parameters
- inherited: boolean
Returns RolePermissionType[] | null
Inherited from UASystemOffNormalAlarm.getRolePermissions
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:205

install_extra_properties

install_extra_properties(): void
private

Returns void
Inherited from UASystemOffNormalAlarm.install_extra_properties
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:135

isDisposed

isDisposed(): boolean
Returns boolean
Inherited from UASystemOffNormalAlarm.isDisposed
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:106

listenerCount

listenerCount<K extends keyof UAObjectEvents>(event: K): number
Type Parameters
- K extends keyof UAObjectEvents
Parameters
- event: K
Returns number
Inherited from UASystemOffNormalAlarm.listenerCount
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:83

off

off<K extends keyof UAObjectEvents>(event: K, listener: UAObjectEvents[K]): this
Type Parameters
- K extends keyof UAObjectEvents
Parameters
- event: K
- listener: UAObjectEvents[K]
Returns this
Inherited from UASystemOffNormalAlarm.off
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:82

on

on<K extends keyof UAObjectEvents>(event: K, listener: UAObjectEvents[K]): this
Type Parameters
- K extends keyof UAObjectEvents
Parameters
- event: K
- listener: UAObjectEvents[K]
Returns this
Inherited from UASystemOffNormalAlarm.on
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:79

once

once<K extends keyof UAObjectEvents>(
event: K,
listener: UAObjectEvents[K],
): this
Type Parameters
- K extends keyof UAObjectEvents
Parameters
- event: K
- listener: UAObjectEvents[K]
Returns this
Inherited from UASystemOffNormalAlarm.once
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:80

raiseEvent

raiseEvent(
eventType: BaseNode<BaseNodeEvents> | EventTypeLike,
eventData: RaiseEventData,
): void
Parameters
- eventType: BaseNode<BaseNodeEvents> | EventTypeLike
- eventData: RaiseEventData
Returns void
Inherited from UASystemOffNormalAlarm.raiseEvent
- Defined in packages/node-opcua-address-space-base/dist/ua_object.d.ts:132

readAttribute

readAttribute(
    context: ISessionContext | null,
    attributeId: AttributeIds,
    indexRange?: NumericRange,
    dataEncoding?: QualifiedNameLike | null,
): DataValue
Parameters
- context: ISessionContext | null
- attributeId: AttributeIds
- OptionalindexRange: NumericRange
- OptionaldataEncoding: QualifiedNameLike | null
Returns DataValue
Inherited from UASystemOffNormalAlarm.readAttribute
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:115

removeAllListeners

removeAllListeners(): void
Returns void
Inherited from UASystemOffNormalAlarm.removeAllListeners
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:85

removeListener

removeListener<K extends keyof UAObjectEvents>(
event: K,
listener: UAObjectEvents[K],
): void
Type Parameters
- K extends keyof UAObjectEvents
Parameters
- event: K
- listener: UAObjectEvents[K]
Returns void
Inherited from UASystemOffNormalAlarm.removeListener
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:86

removeReference

removeReference(referenceOpts: AddReferenceOpts): void
Parameters
- referenceOpts: AddReferenceOpts
Returns void
Inherited from UASystemOffNormalAlarm.removeReference
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:114

setAccessRestrictions

setAccessRestrictions(accessRestrictions: AccessRestrictionsFlag): void
setAccessRestriction
Parameters
- accessRestrictions: AccessRestrictionsFlag
Returns void
Inherited from UASystemOffNormalAlarm.setAccessRestrictions
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:209

setDescription

setDescription(value: LocalizedTextLike | null): void
Parameters
- value: LocalizedTextLike | null
Returns void
Inherited from UASystemOffNormalAlarm.setDescription
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:239

setDisplayName

setDisplayName(value: LocalizedTextLike | LocalizedTextLike[]): void
Parameters
- value: LocalizedTextLike | LocalizedTextLike[]
Returns void
Inherited from UASystemOffNormalAlarm.setDisplayName
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:238

setEventNotifier

setEventNotifier(eventNotifierFlags: EventNotifierFlags): void
Parameters
- eventNotifierFlags: EventNotifierFlags
Returns void
Inherited from UASystemOffNormalAlarm.setEventNotifier
- Defined in packages/node-opcua-address-space-base/dist/ua_object.d.ts:133

setMaxListeners

setMaxListeners(n: number): void
Parameters
- n: number
Returns void
Inherited from UASystemOffNormalAlarm.setMaxListeners
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:84

setRolePermissions

setRolePermissions(rolePermissions: RolePermissionTypeOptions[]): void
Parameters
- rolePermissions: RolePermissionTypeOptions[]
Returns void
Inherited from UASystemOffNormalAlarm.setRolePermissions
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:204

writeAttribute

writeAttribute(
    context: ISessionContext | null,
    writeValue: WriteValueOptions,
    callback: (err: Error | null, statusCode?: StatusCode) => void,
): void
Parameters
- context: ISessionContext | null
- writeValue: WriteValueOptions
- callback: (err: Error | null, statusCode?: StatusCode) => void
Returns void
Inherited from UASystemOffNormalAlarm.writeAttribute
- Defined in packages/node-opcua-address-space-base/dist/base_node.d.ts:116

Interface UACertificateExpirationAlarm

Hierarchy (View Summary)

Index

Properties

Methods

Properties

accessRestrictions

ackedState

acknowledge

activeState

addComment

addressSpace

OptionalaudibleEnabled

OptionalaudibleSound

branchId

ReadonlybrowseName

certificate

certificateType

clientUserId

comment

conditionClassId

conditionClassName

conditionName

conditionRefresh

conditionRefresh2

OptionalconditionSubClassId

OptionalconditionSubClassName

Optionalconfirm

OptionalconfirmedState

description

disable

displayName

enable

enabledState

eventId

ReadonlyeventNotifier

eventType

expirationDate

OptionalexpirationLimit

OptionalfirstInGroup

OptionalfirstInGroupFlag

OptionalgetGroupMemberships

ReadonlyhasMethods

inputNode

lastSeverity

OptionallatchedState

OptionallocalTime

OptionalmaxTimeShelved

message

modellingRule

namespace

namespaceIndex

namespaceUri

ReadonlynodeClass

ReadonlynodeId

normalState

OptionaloffDelay

OptionalonDelay

OptionalonFirstBrowseAction

OptionaloutOfServiceState

parent

parentNodeId

OptionalplaceInService

OptionalplaceInService2

quality

OptionalreAlarmRepeatCount

OptionalreAlarmTime

receiveTime

OptionalremoveFromService

OptionalremoveFromService2

Optionalreset

Optionalreset2

retain

rolePermissions

severity

OptionalshelvingState

Optionalsilence

OptionalsilenceState

sourceName

sourceNode

`Optional`audibleEnabled

`Optional`audibleSound

`Readonly`browseName

`Optional`conditionSubClassId

`Optional`conditionSubClassName

`Optional`confirm

`Optional`confirmedState

`Readonly`eventNotifier

`Optional`expirationLimit

`Optional`firstInGroup

`Optional`firstInGroupFlag

`Optional`getGroupMemberships

`Readonly`hasMethods

`Optional`latchedState

`Optional`localTime

`Optional`maxTimeShelved

`Readonly`nodeClass

`Readonly`nodeId

`Optional`offDelay

`Optional`onDelay

`Optional`onFirstBrowseAction

`Optional`outOfServiceState

`Optional`placeInService

`Optional`placeInService2

`Optional`reAlarmRepeatCount

`Optional`reAlarmTime

`Optional`removeFromService

`Optional`removeFromService2

`Optional`reset

`Optional`reset2

`Optional`shelvingState

`Optional`silence

`Optional`silenceState

`Optional`suppress

`Optional`suppress2

`Optional`suppressedState

`Optional`unsuppress

`Optional`unsuppress2