ユーザー定義関数クライアント ライブラリ リファレンスUser-defined functions client library reference

このドキュメントでは、Azure Digital Twins ユーザー定義関数クライアント ライブラリの参照情報を示します。This document provides reference information for the Azure Digital Twins user-defined functions client library.

ヘルパー メソッドHelper methods

クライアント ライブラリでは、よく使用される操作のヘルパー メソッドが定義されています。The client library defines helper methods for commonly used operations.

getSpaceMetadata(id) ⇒ spacegetSpaceMetadata(id) ⇒ space

空間識別子が指定されると、この関数はグラフから空間を取得します。Given a space identifier, this function retrieves the space from the graph.

種類: グローバル関数Kind: global function

パラメーターParameter 種類Type 説明Description
idid guid 空間識別子Space identifier

getSensorMetadata(id) ⇒ sensorgetSensorMetadata(id) ⇒ sensor

センサーの識別子が指定されると、この関数はグラフからセンサーを取得します。Given a sensor identifier, this function retrieves the sensor from the graph.

種類: グローバル関数Kind: global function

パラメーターParameter 種類Type 説明Description
idid guid センサーの識別子Sensor identifier

getDeviceMetadata(id) ⇒ devicegetDeviceMetadata(id) ⇒ device

デバイスの識別子が指定されると、この関数はグラフからデバイスを取得します。Given a device identifier, this function retrieves the device from the graph.

種類: グローバル関数Kind: global function

パラメーターParameter 種類Type 説明Description
idid guid デバイスの識別子Device identifier

getSensorValue(sensorId, dataType) ⇒ valuegetSensorValue(sensorId, dataType) ⇒ value

センサーの識別子とそのデータ型が指定されると、この関数はそのセンサーの現在の値を取得します。Given a sensor identifier and its data type, this function retrieves the current value for that sensor.

種類: グローバル関数Kind: global function

パラメーターParameter 種類Type 説明Description
sensorIdsensorId guid センサーの識別子Sensor identifier
dataTypedataType string センサーのデータ型Sensor data type

getSpaceValue(spaceId, valueName) ⇒ valuegetSpaceValue(spaceId, valueName) ⇒ value

空間識別子と値名が指定されると、この関数はその空間プロパティの現在の値を取得します。Given a space identifier and the value name, this function retrieves the current value for that space property.

種類: グローバル関数Kind: global function

パラメーターParameter 種類Type 説明Description
spaceIdspaceId guid 空間識別子Space identifier
valueNamevalueName string 空間プロパティの名前Space property name

getSensorHistoryValues(sensorId, dataType) ⇒ value[]getSensorHistoryValues(sensorId, dataType) ⇒ value[]

センサーの識別子とそのデータ型が指定されると、この関数はそのセンサーの履歴の値を取得します。Given a sensor identifier and its data type, this function retrieves the historical values for that sensor.

種類: グローバル関数Kind: global function

パラメーターParameter 種類Type 説明Description
sensorIdsensorId guid センサーの識別子Sensor identifier
dataTypedataType string センサーのデータ型Sensor data type

getSpaceHistoryValues(spaceId, dataType) ⇒ value[]getSpaceHistoryValues(spaceId, dataType) ⇒ value[]

空間識別子と値名が指定されると、この関数は空間のそのプロパティの履歴の値を取得します。Given a space identifier and the value name, this function retrieves the historical values for that property on the space.

種類: グローバル関数Kind: global function

パラメーターParameter 種類Type 説明Description
spaceIdspaceId guid 空間識別子Space identifier
valueNamevalueName string 空間プロパティの名前Space property name

getSpaceChildSpaces(spaceId) ⇒ space[]getSpaceChildSpaces(spaceId) ⇒ space[]

空間識別子が指定されると、この関数はその親空間の子空間を取得します。Given a space identifier, this function retrieves the child spaces for that parent space.

種類: グローバル関数Kind: global function

パラメーターParameter 種類Type 説明Description
spaceIdspaceId guid 空間識別子Space identifier

getSpaceChildSensors(spaceId) ⇒ sensor[]getSpaceChildSensors(spaceId) ⇒ sensor[]

空間識別子が指定されると、この関数はその親空間の子センサーを取得します。Given a space identifier, this function retrieves the child sensors for that parent space.

種類: グローバル関数Kind: global function

パラメーターParameter 種類Type 説明Description
spaceIdspaceId guid 空間識別子Space identifier

getSpaceChildDevices(spaceId) ⇒ device[]getSpaceChildDevices(spaceId) ⇒ device[]

空間識別子が指定されると、この関数はその親空間の子デバイスを取得します。Given a space identifier, this function retrieves the child devices for that parent space.

種類: グローバル関数Kind: global function

パラメーターParameter 種類Type 説明Description
spaceIdspaceId guid 空間識別子Space identifier

getDeviceChildSensors(deviceId) ⇒ sensor[]getDeviceChildSensors(deviceId) ⇒ sensor[]

デバイスの識別子が指定されると、この関数はその親デバイスの子センサーを取得します。Given a device identifier, this function retrieves the child sensors for that parent device.

種類: グローバル関数Kind: global function

パラメーターParameter 種類Type 説明Description
deviceIddeviceId guid デバイスの識別子Device identifier

getSpaceParentSpace(childSpaceId) ⇒ spacegetSpaceParentSpace(childSpaceId) ⇒ space

空間識別子が指定されると、この関数はその親空間を取得します。Given a space identifier, this function retrieves its parent space.

種類: グローバル関数Kind: global function

パラメーターParameter 種類Type 説明Description
childSpaceIdchildSpaceId guid 空間識別子Space identifier

getSensorParentSpace(childSensorId) ⇒ spacegetSensorParentSpace(childSensorId) ⇒ space

センサーの識別子が指定されると、この関数はその親空間を取得します。Given a sensor identifier, this function retrieves its parent space.

種類: グローバル関数Kind: global function

パラメーターParameter 種類Type 説明Description
childSensorIdchildSensorId guid センサーの識別子Sensor identifier

getDeviceParentSpace(childDeviceId) ⇒ spacegetDeviceParentSpace(childDeviceId) ⇒ space

デバイスの識別子が指定されると、この関数はその親空間を取得します。Given a device identifier, this function retrieves its parent space.

種類: グローバル関数Kind: global function

パラメーターParameter 種類Type 説明Description
childDeviceIdchildDeviceId guid デバイスの識別子Device identifier

getSensorParentDevice(childSensorId) ⇒ spacegetSensorParentDevice(childSensorId) ⇒ space

センサーの識別子が指定されると、この関数はその親デバイスを取得します。Given a sensor identifier, this function retrieves its parent device.

種類: グローバル関数Kind: global function

パラメーターParameter 種類Type 説明Description
childSensorIdchildSensorId guid センサーの識別子Sensor identifier

getSpaceExtendedProperty(spaceId, propertyName) ⇒ extendedPropertygetSpaceExtendedProperty(spaceId, propertyName) ⇒ extendedProperty

空間識別子が指定されると、この関数は空間からプロパティとその値を取得します。Given a space identifier, this function retrieves the property and its value from the space.

種類: グローバル関数Kind: global function

パラメーターParameter 種類Type 説明Description
spaceIdspaceId guid 空間識別子Space identifier
propertyNamepropertyName string 空間プロパティの名前Space property name

getSensorExtendedProperty(sensorId, propertyName) ⇒ extendedPropertygetSensorExtendedProperty(sensorId, propertyName) ⇒ extendedProperty

センサーの識別子が指定されると、この関数はセンサーからプロパティとその値を取得します。Given a sensor identifier, this function retrieves the property and its value from the sensor.

種類: グローバル関数Kind: global function

パラメーターParameter 種類Type 説明Description
sensorIdsensorId guid センサーの識別子Sensor identifier
propertyNamepropertyName string センサー プロパティの名前Sensor property name

getDeviceExtendedProperty(deviceId, propertyName) ⇒ extendedPropertygetDeviceExtendedProperty(deviceId, propertyName) ⇒ extendedProperty

デバイスの識別子が指定されると、この関数はデバイスからプロパティとその値を取得します。Given a device identifier, this function retrieves the property and its value from the device.

種類: グローバル関数Kind: global function

パラメーターParameter 種類Type 説明Description
deviceIddeviceId guid デバイスの識別子Device identifier
propertyNamepropertyName string デバイス プロパティの名前Device property name

setSensorValue(sensorId, dataType, value)setSensorValue(sensorId, dataType, value)

この関数は、指定されたデータ型のセンサー オブジェクトの値を設定します。This function sets a value on the sensor object with the given data type.

種類: グローバル関数Kind: global function

パラメーターParameter 種類Type 説明Description
sensorIdsensorId guid センサーの識別子Sensor identifier
dataTypedataType string センサーのデータ型Sensor data type
valuevalue string Value

setSpaceValue(spaceId, dataType, value)setSpaceValue(spaceId, dataType, value)

この関数は、指定されたデータ型の空間オブジェクトの値を設定します。This function sets a value on the space object with the given data type.

種類: グローバル関数Kind: global function

パラメーターParameter 種類Type 説明Description
spaceIdspaceId guid 空間識別子Space identifier
dataTypedataType string データ型Data type
valuevalue string Value

log(message)log(message)

この関数は、ユーザー定義関数内での次のメッセージをログに記録します。This function logs the following message within the user-defined function.

種類: グローバル関数Kind: global function

パラメーターParameter 種類Type 説明Description
messagemessage string 記録されるメッセージMessage to be logged

sendNotification(topologyObjectId, topologyObjectType, payload)sendNotification(topologyObjectId, topologyObjectType, payload)

この関数は、ディスパッチされるカスタム通知を送信します。This function sends a custom notification out to be dispatched.

種類: グローバル関数Kind: global function

パラメーターParameter 種類Type 説明Description
topologyObjectIdtopologyObjectId guid グラフのオブジェクト識別子。Graph object identifier. 例: 空間、センサー、デバイスの ID。Examples are space, sensor, and device ID.
topologyObjectTypetopologyObjectType string 例: センサー、デバイス。Examples are sensor and device.
payloadpayload string 通知と共に送信される JSON ペイロード。The JSON payload to be sent with the notification.

戻り値の型Return types

以下に、クライアント リファレンス ヘルパー メソッドから返される応答モデルを示します。The response models returned from client reference helper methods are described below.

スペースSpace

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "Space",
  "friendlyName": "Conference Room",
  "typeId": 0,
  "parentSpaceId": "00000000-0000-0000-0000-000000000001",
  "subtypeId": 0
}

空間メソッドSpace methods

Parent() ⇒ spaceParent() ⇒ space

この関数は、現在の空間の親空間を返します。This function returns the parent space of the current space.

ChildSensors() ⇒ sensor[]ChildSensors() ⇒ sensor[]

この関数は、現在の空間の子センサーを返します。This function returns the child sensors of the current space.

ChildDevices() ⇒ device[]ChildDevices() ⇒ device[]

この関数は、現在の空間の子デバイスを返します。This function returns the child devices of the current space.

ExtendedProperty(propertyName) ⇒ extendedPropertyExtendedProperty(propertyName) ⇒ extendedProperty

この関数は、現在の空間の拡張プロパティとその値を返します。This function returns the extended property and its value for the current space.

パラメーターParameter 種類Type 説明Description
propertyNamepropertyName string 拡張プロパティの名前Name of the extended property

Value(valueName) ⇒ valueValue(valueName) ⇒ value

この関数は、現在の空間の値を返します。This function returns the value of the current space.

パラメーターParameter 種類Type 説明Description
valueNamevalueName string 値の名前Name of the value

History(valueName) ⇒ value[]History(valueName) ⇒ value[]

この関数は、現在の空間の履歴の値を返します。This function returns the historical values of the current space.

パラメーターParameter 種類Type 説明Description
valueNamevalueName string 値の名前Name of the value

Notify(payload)Notify(payload)

この関数は、指定されたペイロードを含む通知を送信します。This function sends a notification with the specified payload.

パラメーターParameter 種類Type 説明Description
payloadpayload string 通知に含める JSON ペイロードJSON payload to include in the notification

DeviceDevice

{
  "id": "00000000-0000-0000-0000-000000000002",
  "name": "Device",
  "friendlyName": "Temperature Sensing Device",
  "description": "This device contains a sensor that captures temperature readings.",
  "type": "None",
  "subtype": "None",
  "typeId": 0,
  "subtypeId": 0,
  "hardwareId": "ABC123",
  "gatewayId": "ABC",
  "spaceId": "00000000-0000-0000-0000-000000000000"
}

デバイスのメソッドDevice methods

Parent() ⇒ spaceParent() ⇒ space

この関数は、現在のデバイスの親空間を返します。This function returns the parent space of the current device.

ChildSensors() ⇒ sensor[]ChildSensors() ⇒ sensor[]

この関数は、現在のデバイスの子センサーを返します。This function returns the child sensors of the current device.

ExtendedProperty(propertyName) ⇒ extendedPropertyExtendedProperty(propertyName) ⇒ extendedProperty

この関数は、現在のデバイスの拡張プロパティとその値を返します。This function returns the extended property and its value for the current device.

パラメーターParameter 種類Type 説明Description
propertyNamepropertyName string 拡張プロパティの名前Name of the extended property

Notify(payload)Notify(payload)

この関数は、指定されたペイロードを含む通知を送信します。This function sends a notification with the specified payload.

パラメーターParameter 種類Type 説明Description
payloadpayload string 通知に含める JSON ペイロードJSON payload to include in the notification

センサーSensor

{
  "id": "00000000-0000-0000-0000-000000000003",
  "port": "30",
  "pollRate": 3600,
  "dataType": "Temperature",
  "dataSubtype": "None",
  "type": "Classic",
  "portType": "None",
  "dataUnitType": "FahrenheitTemperature",
  "spaceId": "00000000-0000-0000-0000-000000000000",
  "deviceId": "00000000-0000-0000-0000-000000000001",
  "portTypeId": 0,
  "dataUnitTypeId": 0,
  "dataTypeId": 0,
  "dataSubtypeId": 0,
  "typeId": 0  
}

センサーのメソッドSensor methods

Space() ⇒ spaceSpace() ⇒ space

この関数は、現在のセンサーの親空間を返します。This function returns the parent space of the current sensor.

Device() ⇒ deviceDevice() ⇒ device

この関数は、現在のセンサーの親デバイスを返します。This function returns the parent device of the current sensor.

ExtendedProperty(propertyName) ⇒ extendedPropertyExtendedProperty(propertyName) ⇒ extendedProperty

この関数は、現在のセンサーの拡張プロパティとその値を返します。This function returns the extended property and its value for the current sensor.

パラメーターParameter 種類Type 説明Description
propertyNamepropertyName string 拡張プロパティの名前Name of the extended property

Value() ⇒ valueValue() ⇒ value

この関数は、現在のセンサーの値を返します。This function returns the value of the current sensor.

History() ⇒ value[]History() ⇒ value[]

この関数は、現在のセンサーの履歴の値を返します。This function returns the historical values of the current sensor.

Notify(payload)Notify(payload)

この関数は、指定されたペイロードを含む通知を送信します。This function sends a notification with the specified payload.

パラメーターParameter 種類Type 説明Description
payloadpayload string 通知に含める JSON ペイロードJSON payload to include in the notification

Value

{
  "dataType": "Temperature",
  "value": "70",
  "createdTime": ""
}

拡張プロパティExtended property

{
  "name": "OccupancyStatus",
  "value": "Occupied"
}

次の手順Next steps