Kullanıcı tanımlı işlevler istemci kitaplığı başvurusuUser-defined functions client library reference

Bu belge, Azure Digital TWINS Kullanıcı tanımlı işlevler istemci kitaplığı için başvuru bilgileri sağlar.This document provides reference information for the Azure Digital Twins user-defined functions client library.

Yardımcı yöntemlerHelper methods

İstemci kitaplığı, yaygın olarak kullanılan işlemler için yardımcı yöntemleri tanımlar.The client library defines helper methods for commonly used operations.

getSpaceMetadata (kimlik) ⇒ spacegetSpaceMetadata(id) ⇒ space

Alan tanımlayıcısı verildiğinde, bu işlev grafikten alanı alır.Given a space identifier, this function retrieves the space from the graph.

Tür: genel işlevKind: global function

ParametreParameter TürType AçıklamaDescription
numarasınıid guid Boşluk tanımlayıcısıSpace identifier

getSensorMetadata (kimlik) ⇒ sensorgetSensorMetadata(id) ⇒ sensor

Bir algılayıcı tanımlayıcısı verildiğinde, bu işlev algılayıcıyı grafikten alır.Given a sensor identifier, this function retrieves the sensor from the graph.

Tür: genel işlevKind: global function

ParametreParameter TürType AçıklamaDescription
numarasınıid guid Algılayıcı tanımlayıcısıSensor identifier

getDeviceMetadata (kimlik) ⇒ devicegetDeviceMetadata(id) ⇒ device

Bir cihaz tanımlayıcısı verildiğinde, bu işlev cihazı grafikten alır.Given a device identifier, this function retrieves the device from the graph.

Tür: genel işlevKind: global function

ParametreParameter TürType AçıklamaDescription
numarasınıid guid Cihaz tanımlayıcısıDevice identifier

getSensorValue (Sensorıd, dataType) ⇒ valuegetSensorValue(sensorId, dataType) ⇒ value

Bu işlev, bir algılayıcı tanımlayıcısı ve veri türü verildiğinde, bu algılayıcı için geçerli değeri alır.Given a sensor identifier and its data type, this function retrieves the current value for that sensor.

Tür: genel işlevKind: global function

ParametreParameter TürType AçıklamaDescription
SensorıdsensorId guid Algılayıcı tanımlayıcısıSensor identifier
xdataType string Algılayıcı veri türüSensor data type

getSpaceValue (Spaceıd, valueName) ⇒ valuegetSpaceValue(spaceId, valueName) ⇒ value

Bir alan tanımlayıcısı ve değer adı verildiğinde, bu işlev o alan özelliği için geçerli değeri alır.Given a space identifier and the value name, this function retrieves the current value for that space property.

Tür: genel işlevKind: global function

ParametreParameter TürType AçıklamaDescription
SpaceıdspaceId guid Boşluk tanımlayıcısıSpace identifier
valueNamevalueName string Boşluk özelliği adıSpace property name

Getsensorgeçmişini değerleri (Sensorıd, dataType) ⇒ value[]getSensorHistoryValues(sensorId, dataType) ⇒ value[]

Bu işlev, bir algılayıcı tanımlayıcısı ve veri türü verildiğinde, bu algılayıcı için geçmiş değerleri alır.Given a sensor identifier and its data type, this function retrieves the historical values for that sensor.

Tür: genel işlevKind: global function

ParametreParameter TürType AçıklamaDescription
SensorıdsensorId guid Algılayıcı tanımlayıcısıSensor identifier
xdataType string Algılayıcı veri türüSensor data type

Getspaceıvalues değeri (Spaceıd, dataType) ⇒ value[]getSpaceHistoryValues(spaceId, dataType) ⇒ value[]

Alan tanımlayıcısı ve değer adı verildiğinde, bu işlev alandaki bu özelliğin geçmiş değerlerini alır.Given a space identifier and the value name, this function retrieves the historical values for that property on the space.

Tür: genel işlevKind: global function

ParametreParameter TürType AçıklamaDescription
SpaceıdspaceId guid Boşluk tanımlayıcısıSpace identifier
valueNamevalueName string Boşluk özelliği adıSpace property name

getSpaceChildSpaces (Spaceıd) ⇒ space[]getSpaceChildSpaces(spaceId) ⇒ space[]

Bir alan tanımlayıcısı verildiğinde, bu işlev bu üst alanın alt alanlarını alır.Given a space identifier, this function retrieves the child spaces for that parent space.

Tür: genel işlevKind: global function

ParametreParameter TürType AçıklamaDescription
SpaceıdspaceId guid Boşluk tanımlayıcısıSpace identifier

Getspacechildsensörleri (Spaceıd) ⇒ sensor[]getSpaceChildSensors(spaceId) ⇒ sensor[]

Bir alan tanımlayıcısı verildiğinde, bu işlev ilgili üst alana ait alt algılayıcılar alır.Given a space identifier, this function retrieves the child sensors for that parent space.

Tür: genel işlevKind: global function

ParametreParameter TürType AçıklamaDescription
SpaceıdspaceId guid Boşluk tanımlayıcısıSpace identifier

getSpaceChildDevices (Spaceıd) ⇒ device[]getSpaceChildDevices(spaceId) ⇒ device[]

Bir alan tanımlayıcısı verildiğinde, bu işlev bu üst alanın alt cihazlarını alır.Given a space identifier, this function retrieves the child devices for that parent space.

Tür: genel işlevKind: global function

ParametreParameter TürType AçıklamaDescription
SpaceıdspaceId guid Boşluk tanımlayıcısıSpace identifier

Getdevicechildalgılayıcılar (DeviceID) ⇒ sensor[]getDeviceChildSensors(deviceId) ⇒ sensor[]

Bir cihaz tanımlayıcısı verildiğinde, bu işlev ilgili üst cihaz için alt algılayıcılar alır.Given a device identifier, this function retrieves the child sensors for that parent device.

Tür: genel işlevKind: global function

ParametreParameter TürType AçıklamaDescription
DeviceIDdeviceId guid Cihaz tanımlayıcısıDevice identifier

getSpaceParentSpace (Childspaceıd) ⇒ spacegetSpaceParentSpace(childSpaceId) ⇒ space

Bir alan tanımlayıcısı verildiğinde, bu işlev üst alanını alır.Given a space identifier, this function retrieves its parent space.

Tür: genel işlevKind: global function

ParametreParameter TürType AçıklamaDescription
ChildspaceıdchildSpaceId guid Boşluk tanımlayıcısıSpace identifier

getSensorParentSpace (Childsensorıd) ⇒ spacegetSensorParentSpace(childSensorId) ⇒ space

Bir algılayıcı tanımlayıcısı verildiğinde, bu işlev üst alanını alır.Given a sensor identifier, this function retrieves its parent space.

Tür: genel işlevKind: global function

ParametreParameter TürType AçıklamaDescription
ChildsensorıdchildSensorId guid Algılayıcı tanımlayıcısıSensor identifier

getDeviceParentSpace (Childdeviceıd) ⇒ spacegetDeviceParentSpace(childDeviceId) ⇒ space

Bir cihaz tanımlayıcısı verildiğinde, bu işlev üst alanını alır.Given a device identifier, this function retrieves its parent space.

Tür: genel işlevKind: global function

ParametreParameter TürType AçıklamaDescription
ChilddeviceıdchildDeviceId guid Cihaz tanımlayıcısıDevice identifier

getSensorParentDevice (Childsensorıd) ⇒ spacegetSensorParentDevice(childSensorId) ⇒ space

Bir algılayıcı tanımlayıcısı verildiğinde, bu işlev üst cihazını alır.Given a sensor identifier, this function retrieves its parent device.

Tür: genel işlevKind: global function

ParametreParameter TürType AçıklamaDescription
ChildsensorıdchildSensorId guid Algılayıcı tanımlayıcısıSensor identifier

getSpaceExtendedProperty (Spaceıd, propertyName) ⇒ extendedPropertygetSpaceExtendedProperty(spaceId, propertyName) ⇒ extendedProperty

Bir alan tanımlayıcısı verildiğinde, bu işlev özelliği ve değerini alandan alır.Given a space identifier, this function retrieves the property and its value from the space.

Tür: genel işlevKind: global function

ParametreParameter TürType AçıklamaDescription
SpaceıdspaceId guid Boşluk tanımlayıcısıSpace identifier
BaşlamasıpropertyName string Boşluk özelliği adıSpace property name

getSensorExtendedProperty (Sensorıd, propertyName) ⇒ extendedPropertygetSensorExtendedProperty(sensorId, propertyName) ⇒ extendedProperty

Bir algılayıcı tanımlayıcısı verildiğinde, bu işlev özelliği ve onun değerini sensörden alır.Given a sensor identifier, this function retrieves the property and its value from the sensor.

Tür: genel işlevKind: global function

ParametreParameter TürType AçıklamaDescription
SensorıdsensorId guid Algılayıcı tanımlayıcısıSensor identifier
BaşlamasıpropertyName string Algılayıcı özelliği adıSensor property name

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

Bir cihaz tanımlayıcısı verildiğinde, bu işlev özelliği ve değerini cihazdan alır.Given a device identifier, this function retrieves the property and its value from the device.

Tür: genel işlevKind: global function

ParametreParameter TürType AçıklamaDescription
DeviceIDdeviceId guid Cihaz tanımlayıcısıDevice identifier
BaşlamasıpropertyName string Cihaz özelliği adıDevice property name

setSensorValue (Sensorıd, dataType, değer)setSensorValue(sensorId, dataType, value)

Bu işlev, algılayıcı nesnesinde verilen veri türüne sahip bir değer ayarlar.This function sets a value on the sensor object with the given data type.

Tür: genel işlevKind: global function

ParametreParameter TürType AçıklamaDescription
SensorıdsensorId guid Algılayıcı tanımlayıcısıSensor identifier
xdataType string Algılayıcı veri türüSensor data type
valuevalue string DeğerValue

setSpaceValue (Spaceıd, dataType, value)setSpaceValue(spaceId, dataType, value)

Bu işlev, alan nesnesinde verilen veri türüne sahip bir değer ayarlar.This function sets a value on the space object with the given data type.

Tür: genel işlevKind: global function

ParametreParameter TürType AçıklamaDescription
SpaceıdspaceId guid Boşluk tanımlayıcısıSpace identifier
xdataType string Veri türüData type
valuevalue string DeğerValue

günlük (ileti)log(message)

Bu işlev, Kullanıcı tanımlı işlev içinde aşağıdaki iletiyi günlüğe kaydeder.This function logs the following message within the user-defined function.

Tür: genel işlevKind: global function

ParametreParameter TürType AçıklamaDescription
İletimessage string Günlüğe kaydedilecek iletiMessage to be logged

sendNotification (Topologyobjectıd, topologyObjectType, yük)sendNotification(topologyObjectId, topologyObjectType, payload)

Bu işlev, dağıtılması için özel bir bildirim gönderir.This function sends a custom notification out to be dispatched.

Tür: genel işlevKind: global function

ParametreParameter TürType AçıklamaDescription
TopologyobjectıdtopologyObjectId guid Grafik nesnesi tanımlayıcısı.Graph object identifier. Örnek olarak boşluk, algılayıcı ve cihaz KIMLIĞI verilebilir.Examples are space, sensor, and device ID.
topologyObjectTypetopologyObjectType string Örnek algılayıcı ve cihazlardır.Examples are sensor and device.
tepayload string Bildirimle gönderilecek JSON yükü.The JSON payload to be sent with the notification.

Dönüş türleriReturn types

İstemci başvuru Yardımcısı yöntemlerinden döndürülen yanıt modelleri aşağıda açıklanmaktadır.The response models returned from client reference helper methods are described below.

UzaySpace

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

Boşluk yöntemleriSpace methods

Parent () ⇒ spaceParent() ⇒ space

Bu işlev, geçerli alanın üst alanını döndürür.This function returns the parent space of the current space.

Childsensörler () ⇒ sensor[]ChildSensors() ⇒ sensor[]

Bu işlev, geçerli alanın alt sensörleri döndürür.This function returns the child sensors of the current space.

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

Bu işlev, geçerli alanın alt cihazlarını döndürür.This function returns the child devices of the current space.

ExtendedProperty (propertyName) ⇒ extendedPropertyExtendedProperty(propertyName) ⇒ extendedProperty

Bu işlev, geçerli alanın genişletilmiş özelliğini ve değerini döndürür.This function returns the extended property and its value for the current space.

ParametreParameter TürType AçıklamaDescription
BaşlamasıpropertyName string Genişletilmiş özelliğin adıName of the extended property

Değer (valueName) ⇒ valueValue(valueName) ⇒ value

Bu işlev, geçerli alanın değerini döndürür.This function returns the value of the current space.

ParametreParameter TürType AçıklamaDescription
valueNamevalueName string Değerin adıName of the value

Geçmiş (valueName) ⇒ value[]History(valueName) ⇒ value[]

Bu işlev, geçerli alanın geçmiş değerlerini döndürür.This function returns the historical values of the current space.

ParametreParameter TürType AçıklamaDescription
valueNamevalueName string Değerin adıName of the value

Bildir (yük)Notify(payload)

Bu işlev, belirtilen yük ile bir bildirim gönderir.This function sends a notification with the specified payload.

ParametreParameter TürType AçıklamaDescription
tepayload string Bildirime dahil edilecek JSON yüküJSON payload to include in the notification

CihazDevice

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

Cihaz yöntemleriDevice methods

Parent () ⇒ spaceParent() ⇒ space

Bu işlev, geçerli cihazın üst alanını döndürür.This function returns the parent space of the current device.

Childsensörler () ⇒ sensor[]ChildSensors() ⇒ sensor[]

Bu işlev, geçerli cihazın alt sensörleri döndürür.This function returns the child sensors of the current device.

ExtendedProperty (propertyName) ⇒ extendedPropertyExtendedProperty(propertyName) ⇒ extendedProperty

Bu işlev, geçerli cihaz için Genişletilmiş özelliği ve değerini döndürür.This function returns the extended property and its value for the current device.

ParametreParameter TürType AçıklamaDescription
BaşlamasıpropertyName string Genişletilmiş özelliğin adıName of the extended property

Bildir (yük)Notify(payload)

Bu işlev, belirtilen yük ile bir bildirim gönderir.This function sends a notification with the specified payload.

ParametreParameter TürType AçıklamaDescription
tepayload string Bildirime dahil edilecek JSON yüküJSON payload to include in the notification

Algılayıcısı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  
}

Algılayıcı yöntemleriSensor methods

Boşluk () ⇒ spaceSpace() ⇒ space

Bu işlev, geçerli algılayıcının üst alanını döndürür.This function returns the parent space of the current sensor.

Cihaz () ⇒ deviceDevice() ⇒ device

Bu işlev, geçerli algılayıcının ana cihazını döndürür.This function returns the parent device of the current sensor.

ExtendedProperty (propertyName) ⇒ extendedPropertyExtendedProperty(propertyName) ⇒ extendedProperty

Bu işlev, geçerli algılayıcı için Genişletilmiş özelliği ve değerini döndürür.This function returns the extended property and its value for the current sensor.

ParametreParameter TürType AçıklamaDescription
BaşlamasıpropertyName string Genişletilmiş özelliğin adıName of the extended property

Değer () ⇒ valueValue() ⇒ value

Bu işlev, geçerli algılayıcının değerini döndürür.This function returns the value of the current sensor.

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

Bu işlev, geçerli algılayıcının geçmiş değerlerini döndürür.This function returns the historical values of the current sensor.

Bildir (yük)Notify(payload)

Bu işlev, belirtilen yük ile bir bildirim gönderir.This function sends a notification with the specified payload.

ParametreParameter TürType AçıklamaDescription
tepayload string Bildirime dahil edilecek JSON yüküJSON payload to include in the notification

DeğerValue

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

Genişletilmiş özellikExtended property

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

Sonraki adımlarNext steps