مرجع مكتبة عميل الوظائف المعرفة من قبل المستخدم
هام
تم إصدار إصدار جديد من خدمة Azure Digital Twins. في ضوء القدرات الموسعة للخدمة الجديدة، تم إيقاف خدمة Azure Digital Twins الأصلية (الموضحة في مجموعة الوثائق هذه).
لعرض وثائق الخدمة الجديدة، قم بزيارة وثائق Azure Digital Twins النشطة.
يوفر هذا المستند معلومات مرجعية لمكتبة عميل الدالات المعرفة من قبل المستخدم في Azure Digital Twins.
طرق المساعد
تعرف مكتبة العميل أساليب المساعد للعمليات شائعة الاستخدام.
getSpaceMetadata(id) ⇒ space
بالنظر إلى معرف المسافة، تسترد هذه الدالة المسافة من الرسم البياني.
النوع: وظيفة عالمية
| المعلَمة | النوع | الوصف |
|---|---|---|
| المُعرف | guid |
معرف الفضاء |
getSensorMetadata(id) ⇒ sensor
بالنظر إلى معرف المستشعر، تقوم هذه الوظيفة باسترداد المستشعر من الرسم البياني.
النوع: وظيفة عالمية
| المعلَمة | النوع | الوصف |
|---|---|---|
| المُعرف | guid |
معرف المستشعر |
getDeviceMetadata(id) ⇒ device
بالنظر إلى معرف الجهاز، تقوم هذه الوظيفة باسترداد الجهاز من الرسم البياني.
النوع: وظيفة عالمية
| المعلَمة | النوع | الوصف |
|---|---|---|
| المُعرف | guid |
معرف الجهاز |
getSensorValue(sensorId, dataType) ⇒ value
بالنظر إلى معرف المستشعر ونوع البيانات الخاص به ، تسترد هذه الوظيفة القيمة الحالية لهذا المستشعر.
النوع: وظيفة عالمية
| المعلَمة | النوع | الوصف |
|---|---|---|
| sensorId | guid |
معرف المستشعر |
| dataType | string |
نوع بيانات المستشعر |
getSpaceValue(spaceId, valueName) ⇒ value
بالنظر إلى معرف المسافة واسم القيمة، تقوم هذه الدالة باسترداد القيمة الحالية لخاصية المساحة هذه.
النوع: وظيفة عالمية
| المعلَمة | النوع | الوصف |
|---|---|---|
| سبيس آي دي | guid |
معرف الفضاء |
| القيمةالاسم | string |
اسم الخاصية الفضائية |
getSensorHistoryValues(sensorId, dataType) ⇒ value[]
بالنظر إلى معرف المستشعر ونوع البيانات الخاص به ، تسترد هذه الوظيفة القيم التاريخية لهذا المستشعر.
النوع: وظيفة عالمية
| المعلَمة | النوع | الوصف |
|---|---|---|
| sensorId | guid |
معرف المستشعر |
| dataType | string |
نوع بيانات المستشعر |
getSpaceHistoryValues(spaceId, dataType) ⇒ value[]
بالنظر إلى معرف المسافة واسم القيمة، تقوم هذه الدالة باسترداد القيم التاريخية لتلك الخاصية على المسافة.
النوع: وظيفة عالمية
| المعلَمة | النوع | الوصف |
|---|---|---|
| سبيس آي دي | guid |
معرف الفضاء |
| القيمةالاسم | string |
اسم الخاصية الفضائية |
getSpaceChildSpaces(spaceId) ⇒ space[]
بالنظر إلى معرف مساحة، تقوم هذه الوظيفة باسترداد المساحات الفرعية لتلك المساحة الأصلية.
النوع: وظيفة عالمية
| المعلَمة | النوع | الوصف |
|---|---|---|
| سبيس آي دي | guid |
معرف الفضاء |
getSpaceChildSensors(spaceId) ⇒ sensor[]
بالنظر إلى معرف الفضاء، تقوم هذه الوظيفة باسترداد المستشعرات الفرعية لتلك المساحة الأصلية.
النوع: وظيفة عالمية
| المعلَمة | النوع | الوصف |
|---|---|---|
| سبيس آي دي | guid |
معرف الفضاء |
getSpaceChildDevices(spaceId) ⇒ device[]
بالنظر إلى معرف مساحة، تقوم هذه الوظيفة باسترداد الأجهزة الفرعية لتلك المساحة الأصلية.
النوع: وظيفة عالمية
| المعلَمة | النوع | الوصف |
|---|---|---|
| سبيس آي دي | guid |
معرف الفضاء |
getDeviceChildSensors(deviceId) ⇒ sensor[]
بالنظر إلى معرف الجهاز، تقوم هذه الوظيفة باسترداد المستشعرات الفرعية لهذا الجهاز الأصل.
النوع: وظيفة عالمية
| المعلَمة | النوع | الوصف |
|---|---|---|
| معرف الجهاز | guid |
معرف الجهاز |
getSpaceParentSpace(childSpaceId) ⇒ space
بالنظر إلى معرف الفضاء، تسترد هذه الوظيفة المساحة الأصلية.
النوع: وظيفة عالمية
| المعلَمة | النوع | الوصف |
|---|---|---|
| childSpaceId | guid |
معرف الفضاء |
getSensorParentSpace(childSensorId) ⇒ space
بالنظر إلى معرف المستشعر، تسترد هذه الوظيفة المساحة الأصلية.
النوع: وظيفة عالمية
| المعلَمة | النوع | الوصف |
|---|---|---|
| الطفلSensorId | guid |
معرف المستشعر |
⇒ getDeviceParentSpace (childDeviceId) space
بالنظر إلى معرف الجهاز، تسترد هذه الوظيفة المساحة الأصلية.
النوع: وظيفة عالمية
| المعلَمة | النوع | الوصف |
|---|---|---|
| الطفلDeviceId | guid |
معرف الجهاز |
getSensorParentDevice(childSensorId) ⇒ space
بالنظر إلى معرف المستشعر، تسترد هذه الوظيفة جهازها الأصلي.
النوع: وظيفة عالمية
| المعلَمة | النوع | الوصف |
|---|---|---|
| الطفلSensorId | guid |
معرف المستشعر |
getSpaceExtendedProperty(spaceId, propertyName) ⇒ extendedProperty
بالنظر إلى معرف الفضاء، تسترد هذه الدالة الخاصية وقيمتها من المسافة.
النوع: وظيفة عالمية
| المعلَمة | النوع | الوصف |
|---|---|---|
| سبيس آي دي | guid |
معرف الفضاء |
| propertyName | string |
اسم الخاصية الفضائية |
getSensorExtendedProperty(sensorId, propertyName) ⇒ extendedProperty
بالنظر إلى معرف المستشعر، تسترد هذه الوظيفة الخاصية وقيمتها من المستشعر.
النوع: وظيفة عالمية
| المعلَمة | النوع | الوصف |
|---|---|---|
| sensorId | guid |
معرف المستشعر |
| propertyName | string |
اسم خاصية المستشعر |
getDeviceExtendedProperty(deviceId, propertyName) ⇒ extendedProperty
نظرا لمعرف الجهاز، تقوم هذه الوظيفة باسترداد الخاصية وقيمتها من الجهاز.
النوع: وظيفة عالمية
| المعلَمة | النوع | الوصف |
|---|---|---|
| معرف الجهاز | guid |
معرف الجهاز |
| propertyName | string |
اسم خاصية الجهاز |
setSensorValue(sensorId, dataType, value)
تقوم هذه الوظيفة بتعيين قيمة على كائن المستشعر بنوع البيانات المحدد.
النوع: وظيفة عالمية
| المعلَمة | النوع | الوصف |
|---|---|---|
| sensorId | guid |
معرف المستشعر |
| dataType | string |
نوع بيانات المستشعر |
| value | string |
القيمة |
setSpaceValue(spaceId, dataType, value)
تعين هذه الدالة قيمة على الجسم الفضائي بنوع البيانات المحدد.
النوع: وظيفة عالمية
| المعلَمة | النوع | الوصف |
|---|---|---|
| سبيس آي دي | guid |
معرف الفضاء |
| dataType | string |
نوع البيانات |
| value | string |
القيمة |
سجل (رسالة)
تسجل هذه الدالة الرسالة التالية داخل الدالة المعرفة من قبل المستخدم.
النوع: وظيفة عالمية
| المعلَمة | النوع | الوصف |
|---|---|---|
| رسالة | string |
الرسالة المراد تسجيلها |
sendNotification(طوبولوجياObjectId، طوبولوجياObjectType، الحمولة)
ترسل هذه الوظيفة إشعارا مخصصا ليتم إرساله.
النوع: وظيفة عالمية
| المعلَمة | النوع | الوصف |
|---|---|---|
| طوبولوجياObjectId | guid |
معرف كائن Graph. ومن الأمثلة على ذلك المساحة والمستشعر ومعرف الجهاز. |
| طوبولوجيانوع الكائن | string |
ومن الأمثلة على ذلك أجهزة الاستشعار والجهاز. |
| حموله | string |
سيتم إرسال حمولة JSON مع الإشعار. |
أنواع الإرجاع
يتم وصف نماذج الاستجابة التي تم إرجاعها من أساليب مساعد مرجع العميل أدناه.
المساحة
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "Space",
"friendlyName": "Conference Room",
"typeId": 0,
"parentSpaceId": "00000000-0000-0000-0000-000000000001",
"subtypeId": 0
}
طرق الفضاء
الوالدين() ⇒ space
ترجع هذه الدالة المساحة الأصل للمساحة الحالية.
أجهزة استشعار الأطفال() ⇒ sensor[]
ترجع هذه الوظيفة مستشعرات الطفل للمساحة الحالية.
أجهزة الأطفال() ⇒ device[]
ترجع هذه الدالة الأجهزة التابعة للمساحة الحالية.
⇒ ExtendedProperty(propertyName) extendedProperty
ترجع هذه الدالة الخاصية الموسعة وقيمتها للمساحة الحالية.
| المعلَمة | النوع | الوصف |
|---|---|---|
| propertyName | string |
اسم العقار الموسع |
⇒ القيمة (القيمة) value
ترجع هذه الدالة قيمة المساحة الحالية.
| المعلَمة | النوع | الوصف |
|---|---|---|
| القيمةالاسم | string |
اسم القيمة |
⇒ التاريخ (القيمة) value[]
ترجع هذه الدالة القيم التاريخية للمساحة الحالية.
| المعلَمة | النوع | الوصف |
|---|---|---|
| القيمةالاسم | string |
اسم القيمة |
إخطار (الحمولة)
ترسل هذه الوظيفة إشعارا بالحمولة المحددة.
| المعلَمة | النوع | الوصف |
|---|---|---|
| حموله | 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"
}
طرق الجهاز
الوالدين() ⇒ space
ترجع هذه الوظيفة المساحة الأصل للجهاز الحالي.
أجهزة استشعار الأطفال() ⇒ sensor[]
ترجع هذه الوظيفة المستشعرات الفرعية للجهاز الحالي.
⇒ ExtendedProperty(propertyName) extendedProperty
ترجع هذه الدالة الخاصية الموسعة وقيمتها للجهاز الحالي.
| المعلَمة | النوع | الوصف |
|---|---|---|
| propertyName | string |
اسم العقار الموسع |
إخطار (الحمولة)
ترسل هذه الوظيفة إشعارا بالحمولة المحددة.
| المعلَمة | النوع | الوصف |
|---|---|---|
| حموله | string |
حمولة JSON لتضمينها في الإشعار |
المستشعر
{
"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
ترجع هذه الوظيفة المساحة الأصل للمستشعر الحالي.
الجهاز() ⇒ device
ترجع هذه الوظيفة الجهاز الأصل للمستشعر الحالي.
⇒ ExtendedProperty(propertyName) extendedProperty
ترجع هذه الدالة الخاصية الموسعة وقيمتها للمستشعر الحالي.
| المعلَمة | النوع | الوصف |
|---|---|---|
| propertyName | string |
اسم العقار الموسع |
قيمة() ⇒ value
ترجع هذه الدالة قيمة المستشعر الحالي.
التاريخ() ⇒ value[]
ترجع هذه الدالة القيم التاريخية للمستشعر الحالي.
إخطار (الحمولة)
ترسل هذه الوظيفة إشعارا بالحمولة المحددة.
| المعلَمة | النوع | الوصف |
|---|---|---|
| حموله | string |
حمولة JSON لتضمينها في الإشعار |
القيمة
{
"dataType": "Temperature",
"value": "70",
"createdTime": ""
}
الممتلكات الموسعة
{
"name": "OccupancyStatus",
"value": "Occupied"
}