使用者定義函式用戶端程式庫參考

發行項
01/17/2020

重要

已發行新版本的 Azure Digital Twins 服務。在新的服務擴充功能中，本檔集) 中所述的原始 Azure Digital Twins 服務 (已淘汰。

若要檢視新服務的檔，請流覽使用中的 Azure Digital Twins 檔。

本文提供 Azure Digital Twins 使用者定義函式用戶端程式庫的參考資訊。

協助程式方法

用戶端程式庫定義常用作業的協助程式方法。

getSpaceMetadata(id) ⇒ `space`

此函式根據指定的空間識別碼，從圖表擷取空間。

種類：全域函式

參數	類型	描述
id	`guid`	空間識別碼

getSensorMetadata(id) ⇒ `sensor`

此函式根據指定的感應器識別碼，從圖表擷取感應器。

種類：全域函式

參數	類型	描述
id	`guid`	感應器識別碼

getDeviceMetadata(id) ⇒ `device`

此函式根據指定的裝置識別碼，從圖表擷取裝置。

種類：全域函式

參數	類型	描述
id	`guid`	裝置識別碼

getSensorValue(sensorId, dataType) ⇒ `value`

此函式根據指定的感應器識別碼和其資料類型，擷取該感應器的目前值。

種類：全域函式

參數	類型	Description
sensorId	`guid`	感應器識別碼
dataType	`string`	感應器資料類型

getSpaceValue(spaceId, valueName) ⇒ `value`

此函式根據指定的空間識別碼和值的名稱，擷取該空間屬性的目前值。

種類：全域函式

參數	類型	Description
spaceId	`guid`	空間識別碼
valueName	`string`	空間屬性名稱

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

此函式根據指定的感應器識別碼和其資料類型，擷取該感應器的歷史值。

種類：全域函式

參數	類型	Description
sensorId	`guid`	感應器識別碼
dataType	`string`	感應器資料類型

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

此函式根據指定的空間識別碼和值的名稱，擷取空間上該屬性的歷史值。

種類：全域函式

參數	類型	Description
spaceId	`guid`	空間識別碼
valueName	`string`	空間屬性名稱

getSpaceChildSpaces(spaceId) ⇒ `space[]`

此函式根據指定的空間識別碼，擷取該父空間的子空間。

種類：全域函式

參數	類型	Description
spaceId	`guid`	空間識別碼

getSpaceChildSensors(spaceId) ⇒ `sensor[]`

此函式根據指定的空間識別碼，擷取該父空間的子感應器。

種類：全域函式

參數	類型	Description
spaceId	`guid`	空間識別碼

getSpaceChildDevices(spaceId) ⇒ `device[]`

此函式根據指定的空間識別碼，擷取該父空間的子裝置。

種類：全域函式

參數	類型	Description
spaceId	`guid`	空間識別碼

getDeviceChildSensors(deviceId) ⇒ `sensor[]`

此函式根據指定的裝置識別碼，擷取該父裝置的子感應器。

種類：全域函式

參數	類型	Description
deviceId	`guid`	裝置識別碼

getSpaceParentSpace(childSpaceId) ⇒ `space`

此函式根據指定的空間識別碼，擷取其父空間。

種類：全域函式

參數	類型	Description
childSpaceId	`guid`	空間識別碼

getSensorParentSpace(childSensorId) ⇒ `space`

此函式根據指定的感應器識別碼，擷取其父空間。

種類：全域函式

參數	類型	Description
childSensorId	`guid`	感應器識別碼

getDeviceParentSpace(childDeviceId) ⇒ `space`

此函式根據指定的裝置識別碼，擷取其父空間。

種類：全域函式

參數	類型	Description
childDeviceId	`guid`	裝置識別碼

getSensorParentDevice(childSensorId) ⇒ `space`

此函式根據指定的感應器識別碼，擷取其父裝置。

種類：全域函式

參數	類型	Description
childSensorId	`guid`	感應器識別碼

getSpaceExtendedProperty(spaceId, propertyName) ⇒ `extendedProperty`

此函式根據指定的空間識別碼，從該空間擷取屬性和其值。

種類：全域函式

參數	類型	Description
spaceId	`guid`	空間識別碼
propertyName	`string`	空間屬性名稱

getSensorExtendedProperty(sensorId, propertyName) ⇒ `extendedProperty`

此函式根據指定的感應器識別碼，從該感應器擷取屬性和其值。

種類：全域函式

參數	類型	Description
sensorId	`guid`	感應器識別碼
propertyName	`string`	感應器屬性名稱

getDeviceExtendedProperty(deviceId, propertyName) ⇒ `extendedProperty`

此函式根據指定的裝置識別碼，從該裝置擷取屬性和其值。

種類：全域函式

參數	類型	Description
deviceId	`guid`	裝置識別碼
propertyName	`string`	裝置屬性名稱

setSensorValue(sensorId, dataType, value)

此函式在具有指定資料類型的感應器物件上設定值。

種類：全域函式

參數	類型	Description
sensorId	`guid`	感應器識別碼
dataType	`string`	感應器資料類型
value	`string`	值

setSpaceValue(spaceId, dataType, value)

此函式在具有指定資料類型的空間物件上設定值。

種類：全域函式

參數	類型	Description
spaceId	`guid`	空間識別碼
dataType	`string`	資料類型
value	`string`	值

log(message)

此函式記錄使用者定義函式中的下列訊息。

種類：全域函式

參數	類型	描述
message	`string`	要記錄的訊息

sendNotification(topologyObjectId, topologyObjectType, payload)

此函式傳送出要分派的自訂通知。

種類：全域函式

參數	類型	Description
topologyObjectId	`guid`	圖表物件識別碼。範例如空間、感應器和裝置識別碼。
topologyObjectType	`string`	範例如感應器和裝置。
負載	`string`	與通知一起傳送的 JSON 承載。

傳回類型

用戶端參考協助程式方法傳回的回應模型如下所示。

Space

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

空間方法

Parent() ⇒ `space`

此函式傳回目前空間的父空間。

ChildSensors() ⇒ `sensor[]`

此函式傳回目前空間的子感應器。

ChildDevices() ⇒ `device[]`

此函式傳回目前空間的子裝置。

ExtendedProperty(propertyName) ⇒ `extendedProperty`

此函式傳回目前空間的擴充屬性和其值。

參數	類型	Description
propertyName	`string`	擴充屬性的名稱

Value(valueName) ⇒ `value`

此函式傳回目前空間的值。

參數	類型	Description
valueName	`string`	值的名稱

History(valueName) ⇒ `value[]`

此函式傳回目前空間的歷史值。

參數	類型	Description
valueName	`string`	值的名稱

Notify(payload)

此函式傳送具有指定承載的通知。

參數	類型	Description
負載	`string`	要包含在通知中的 JSON 承載

裝置

{
  "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"
}

裝置方法

Parent() ⇒ `space`

此函式傳回目前裝置的父空間。

ChildSensors() ⇒ `sensor[]`

此函式傳回目前裝置的子感應器。

ExtendedProperty(propertyName) ⇒ `extendedProperty`

此函式傳回目前裝置的擴充屬性和其值。

參數	類型	Description
propertyName	`string`	擴充屬性的名稱

Notify(payload)

此函式傳送具有指定承載的通知。

參數	類型	Description
負載	`string`	要包含在通知中的 JSON 承載

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  
}

感應器方法

Space() ⇒ `space`

此函式傳回目前感應器的父空間。

Device() ⇒ `device`

此函式傳回目前感應器的父裝置。

ExtendedProperty(propertyName) ⇒ `extendedProperty`

此函式傳回目前感應器的擴充屬性和其值。

參數	類型	Description
propertyName	`string`	擴充屬性的名稱

Value() ⇒ `value`

此函式傳回目前感應器的值。

History() ⇒ `value[]`

此函式傳回目前感應器的歷史值。

Notify(payload)

此函式傳送具有指定承載的通知。

參數	類型	Description
負載	`string`	要包含在通知中的 JSON 承載

值

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

擴充的屬性

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

共用方式為

使用者定義函式用戶端程式庫參考

協助程式方法

getSpaceMetadata(id) ⇒ space

getSensorMetadata(id) ⇒ sensor

getDeviceMetadata(id) ⇒ device

getSensorValue(sensorId, dataType) ⇒ value

getSpaceValue(spaceId, valueName) ⇒ value

getSensorHistoryValues(sensorId, dataType) ⇒ value[]

getSpaceHistoryValues(spaceId, dataType) ⇒ value[]

getSpaceChildSpaces(spaceId) ⇒ space[]

getSpaceChildSensors(spaceId) ⇒ sensor[]

getSpaceChildDevices(spaceId) ⇒ device[]

getDeviceChildSensors(deviceId) ⇒ sensor[]

getSpaceParentSpace(childSpaceId) ⇒ space

getSensorParentSpace(childSensorId) ⇒ space

getDeviceParentSpace(childDeviceId) ⇒ space

getSensorParentDevice(childSensorId) ⇒ space

getSpaceExtendedProperty(spaceId, propertyName) ⇒ extendedProperty

getSensorExtendedProperty(sensorId, propertyName) ⇒ extendedProperty

getDeviceExtendedProperty(deviceId, propertyName) ⇒ extendedProperty

setSensorValue(sensorId, dataType, value)

setSpaceValue(spaceId, dataType, value)

log(message)

sendNotification(topologyObjectId, topologyObjectType, payload)

傳回類型

Space

空間方法

Parent() ⇒ space

ChildSensors() ⇒ sensor[]

ChildDevices() ⇒ device[]

ExtendedProperty(propertyName) ⇒ extendedProperty

Value(valueName) ⇒ value

History(valueName) ⇒ value[]

Notify(payload)

裝置

裝置方法

Parent() ⇒ space

ChildSensors() ⇒ sensor[]

ExtendedProperty(propertyName) ⇒ extendedProperty

Notify(payload)

Sensor

感應器方法

Space() ⇒ space

Device() ⇒ device

ExtendedProperty(propertyName) ⇒ extendedProperty

Value() ⇒ value

History() ⇒ value[]

Notify(payload)

值

擴充的屬性

後續步驟

其他資源

getSpaceMetadata(id) ⇒ `space`

getSensorMetadata(id) ⇒ `sensor`

getDeviceMetadata(id) ⇒ `device`

getSensorValue(sensorId, dataType) ⇒ `value`

getSpaceValue(spaceId, valueName) ⇒ `value`

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

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

getSpaceChildSpaces(spaceId) ⇒ `space[]`

getSpaceChildSensors(spaceId) ⇒ `sensor[]`

getSpaceChildDevices(spaceId) ⇒ `device[]`

getDeviceChildSensors(deviceId) ⇒ `sensor[]`

getSpaceParentSpace(childSpaceId) ⇒ `space`

getSensorParentSpace(childSensorId) ⇒ `space`

getDeviceParentSpace(childDeviceId) ⇒ `space`

getSensorParentDevice(childSensorId) ⇒ `space`

getSpaceExtendedProperty(spaceId, propertyName) ⇒ `extendedProperty`

getSensorExtendedProperty(sensorId, propertyName) ⇒ `extendedProperty`

getDeviceExtendedProperty(deviceId, propertyName) ⇒ `extendedProperty`

Parent() ⇒ `space`

ChildSensors() ⇒ `sensor[]`

ChildDevices() ⇒ `device[]`

ExtendedProperty(propertyName) ⇒ `extendedProperty`

Value(valueName) ⇒ `value`

History(valueName) ⇒ `value[]`

Parent() ⇒ `space`

ChildSensors() ⇒ `sensor[]`

ExtendedProperty(propertyName) ⇒ `extendedProperty`

Space() ⇒ `space`

Device() ⇒ `device`

ExtendedProperty(propertyName) ⇒ `extendedProperty`

Value() ⇒ `value`

History() ⇒ `value[]`