Skip to main content
Version: v1

SetValue Interface

Modifies the payload of a node.

Signature​

export interface SetValue

Properties​

Property Type Description
nodeToModify NodeId
payload Payload | null Sets or clears the payload. To improve ease of forwards compatibility, an explicit null value is used to represent the clearing of a payload. SetValue may use undefined in future API versions to mean "don't change the payload" (which is useful if e.g. other fields are added to SetValue that can be changed without altering the payload)
type typeof ChangeType.SetValue

Property Details​

nodeToModify​

Signature​

readonly nodeToModify: NodeId;

Type: NodeId

payload​

Sets or clears the payload. To improve ease of forwards compatibility, an explicit null value is used to represent the clearing of a payload. SetValue may use undefined in future API versions to mean "don't change the payload" (which is useful if e.g. other fields are added to SetValue that can be changed without altering the payload)

Signature​

readonly payload: Payload | null;

Type: Payload | null

type​

Signature​

readonly type: typeof ChangeType.SetValue;

Type: typeof ChangeType.SetValue