DeviceMethodResponse class

الحزمة:

azure-iot-device

يتم توفير كائن DeviceMethodResponse للمستخدم مع كل DeviceMethodRequest مما يسمح للمستخدم بإنشاء وإرسال استجابة منسقة جيدا مرة أخرى إلى الخدمة لكل استدعاء أسلوب جهاز. يتم تمرير مثيل من هذه الفئة كمعلمة ثانية إلى رد الاتصال المسجل عبر onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).

المنشئون

DeviceMethodResponse(string, DeviceTransport)

الخصائص

isResponseComplete	منطقي يشير إلى ما إذا كان قد تم إرسال الاستجابة بالفعل.
payload	يتم إرسال حمولة الاستجابة مرة أخرى إلى المتصل على جانب الخدمة.
requestId	معرف الطلب الذي توفره الخدمة لاستدعاء أسلوب الجهاز هذا.
status	رمز الحالة الذي يشير إلى نجاح الأسلوب (200) أم لا (أي رقم آخر ليس 200).

الأساليب

send(number, any)
send(number, any, ErrorCallback)	يرسل استجابة أسلوب الجهاز مرة أخرى إلى الخدمة عبر كائن النقل الأساسي باستخدام معلمة الحالة كحالة استدعاء الأسلوب.
send(number, ErrorCallback)

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

DeviceMethodResponse(string, DeviceTransport)

new DeviceMethodResponse(requestId: string, transport: DeviceTransport)

المعلمات

requestId

string

transport

DeviceTransport

تفاصيل الخاصية

isResponseComplete

منطقي يشير إلى ما إذا كان قد تم إرسال الاستجابة بالفعل.

isResponseComplete: boolean

قيمة الخاصية

boolean

payload

يتم إرسال حمولة الاستجابة مرة أخرى إلى المتصل على جانب الخدمة.

payload: any

قيمة الخاصية

any

requestId

معرف الطلب الذي توفره الخدمة لاستدعاء أسلوب الجهاز هذا.

requestId: string

قيمة الخاصية

string

status

رمز الحالة الذي يشير إلى نجاح الأسلوب (200) أم لا (أي رقم آخر ليس 200).

status: number

قيمة الخاصية

number

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

send(number, any)

function send(status: number, payload?: any): Promise<void>

المعلمات

status

number

payload

any

المرتجعات

Promise<void>

send(number, any, ErrorCallback)

يرسل استجابة أسلوب الجهاز مرة أخرى إلى الخدمة عبر كائن النقل الأساسي باستخدام معلمة الحالة كحالة استدعاء الأسلوب.

function send(status: number, payload?: any, done?: ErrorCallback)

المعلمات

status

number

رمز حالة رقمي ليتم إرساله مرة أخرى إلى الخدمة.

payload

any

[اختياري] حمولة استجابة الأسلوب.

done

ErrorCallback

[اختياري] دالة رد الاتصال التي سيتم استدعاؤها بمجرد إرسال الاستجابة مرة أخرى إلى الخدمة. يتم تمرير كائن خطأ كوسيطة إلى الدالة في حالة حدوث خطأ. إذا لم يتم تحديد رد الاتصال، فسيتم إرجاع وعد.

send(number, ErrorCallback)

function send(status: number, done: ErrorCallback)

المعلمات

status

number

done

ErrorCallback