DigitalTwinClient class

الحزمة:

azure-iothub

المنشئون

DigitalTwinClient(IoTHubTokenCredentials)

الدالة الإنشائية التي تنشئ أيضا مثيلا لعميل طبقة البروتوكول الذي يستخدمه DigitalTwinClient.

الأساليب

getDigitalTwin(string)	استرداد Digital Twin لجهاز معين.
getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>)
invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)	استدعاء أمر على مكون جهاز معين والحصول على نتيجة ذلك.
invokeComponentCommand(string, string, string, any, DigitalTwinInvokeComponentCommandOptionalParams)	استدعاء أمر على مكون جهاز معين والحصول على نتيجة ذلك.
updateDigitalTwin(string, any[], string | TripleValueCallback<void, HttpOperationResponse>, TripleValueCallback<void, HttpOperationResponse>)
updateDigitalTwin(string, any[], string)	تحديث Digital Twin لجهاز معين باستخدام كائن تصحيح.

تفاصيل المنشئ

DigitalTwinClient(IoTHubTokenCredentials)

الدالة الإنشائية التي تنشئ أيضا مثيلا لعميل طبقة البروتوكول الذي يستخدمه DigitalTwinClient.

new DigitalTwinClient(creds: IoTHubTokenCredentials)

المعلمات

creds

IoTHubTokenCredentials

بيانات اعتماد الرمز المميز IoTHub المستخدمة لإنشاء عميل طبقة البروتوكول.

تفاصيل الأسلوب

getDigitalTwin(string)

استرداد Digital Twin لجهاز معين.

function getDigitalTwin(digitalTwinId: string): Promise<DigitalTwinResponse>

المعلمات

digitalTwinId

string

معرف التوأم الرقمي للجهاز أو الوحدة النمطية المحددة. تنسيق digitalTwinId هو DeviceId[~ModuleId]. ModuleId اختياري.

المرتجعات

Promise<DigitalTwinResponse>

DigitalTwinResponse كائن الإرجاع الذي يحتوي على Digital Twin بالإضافة إلى HttpResponse.

getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>)

function getDigitalTwin(digitalTwinId: string, callback: TripleValueCallback<DigitalTwin, HttpOperationResponse>)

المعلمات

digitalTwinId

string

callback

TripleValueCallback<DigitalTwin, HttpOperationResponse>

invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

استدعاء أمر على مكون جهاز معين والحصول على نتيجة ذلك.

function invokeCommand(digitalTwinId: string, commandName: string, argument: any, options?: DigitalTwinInvokeRootLevelCommandOptionalParams): Promise<DigitalTwinInvokeRootLevelCommandResponse>

المعلمات

digitalTwinId

string

معرف التوأم الرقمي للجهاز المحدد.

commandName

string

argument

any

وسيطة أمر.

options

DigitalTwinInvokeRootLevelCommandOptionalParams

المعلمة الاختيارية لتعيين الخيارات بما في ذلك connectionTimeoutInSeconds و responseTimeoutInSeconds. يجب أن تكون responseTimeoutInSeconds ضمن [5; 300]

المرتجعات

Promise<DigitalTwinInvokeRootLevelCommandResponse>

DigitalTwinInvokeRootLevelCommandResponse نتيجة الأمر الذي تم استدعاؤه الذي يحتوي على النتيجة ورمز الحالة ومعرف الطلب وHttpResponse الذي تم تحليله.

invokeComponentCommand(string, string, string, any, DigitalTwinInvokeComponentCommandOptionalParams)

استدعاء أمر على مكون جهاز معين والحصول على نتيجة ذلك.

function invokeComponentCommand(digitalTwinId: string, componentName: string, commandName: string, argument: any, options?: DigitalTwinInvokeComponentCommandOptionalParams): Promise<DigitalTwinInvokeComponentCommandResponse>

المعلمات

digitalTwinId

string

معرف التوأم الرقمي للجهاز المحدد.

componentName

string

اسم المكون.

commandName

string

اسم الأمر.

argument

any

وسيطة أمر.

options

DigitalTwinInvokeComponentCommandOptionalParams

المعلمة الاختيارية لتعيين الخيارات بما في ذلك connectionTimeoutInSeconds و responseTimeoutInSeconds. يجب أن تكون responseTimeoutInSeconds ضمن [5; 300]

المرتجعات

Promise<DigitalTwinInvokeComponentCommandResponse>

DigitalTwinInvokeComponentCommandResponse نتيجة الأمر الذي تم استدعاؤه الذي يحتوي على النتيجة ورمز الحالة ومعرف الطلب وHttpResponse الذي تم تحليله.

updateDigitalTwin(string, any[], string | TripleValueCallback<void, HttpOperationResponse>, TripleValueCallback<void, HttpOperationResponse>)

function updateDigitalTwin(digitalTwinId: string, patch: any[], eTagOrCallback?: string | TripleValueCallback<void, HttpOperationResponse>, callback?: TripleValueCallback<void, HttpOperationResponse>)

المعلمات

digitalTwinId

string

patch

any[]

eTagOrCallback

string | TripleValueCallback<void, HttpOperationResponse>

callback

TripleValueCallback<void, HttpOperationResponse>

updateDigitalTwin(string, any[], string)

تحديث Digital Twin لجهاز معين باستخدام كائن تصحيح.

function updateDigitalTwin(digitalTwinId: string, patch: any[], eTag?: string): Promise<DigitalTwinUpdateResponse>

المعلمات

digitalTwinId

string

معرف التوأم الرقمي للجهاز المحدد.

patch

any[]

يحتوي objet التصحيح على جزء التحديث من Digital Twin.

eTag

string

eTag لتحديد التصحيح.

المرتجعات

Promise<DigitalTwinUpdateResponse>

DigitalTwinUpdateResponse The HTTPesponse.