Aracılığıyla paylaş

DeviceMethodResponse class

  • Başvuru
Paket:
azure-iot-device

DeviceMethodResponse her biri kullanıcının DeviceMethodRequest her cihaz yöntemi çağrısı için iyi biçimlendirilmiş bir yanıt oluşturmasına ve hizmete geri göndermesine olanak sağlayan bir nesnesi sağlanır. Bu sınıfın bir örneği, aracılığıyla onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)kaydedilen geri çağırmaya ikinci parametre olarak geçirilir.

Oluşturucular

DeviceMethodResponse(string, DeviceTransport)

Özellikler

isResponseComplete

Yanıtın zaten gönderilip gönderilmediğini gösteren Boole değeri.
payload

Yanıtın yükü, hizmet tarafındaki çağırana geri gönderilir.
requestId

Bu cihaz yöntemi çağrısı için hizmet tarafından sağlanan istek tanımlayıcısı.
status

Yöntemin başarılı (200) olup olmadığını (200 olmayan başka bir sayı) gösteren durum kodu.

Yöntemler

send(number, any)
send(number, any, ErrorCallback)

Yöntem çağrısının durumu olarak durum parametresini kullanarak cihaz yönteminin yanıtını temel alınan aktarım nesnesi aracılığıyla hizmete geri gönderir.
send(number, ErrorCallback)

Oluşturucu Ayrıntıları

DeviceMethodResponse(string, DeviceTransport) 

new DeviceMethodResponse(requestId: string, transport: DeviceTransport)

Parametreler

requestId

string

transport
DeviceTransport

Özellik Ayrıntıları

isResponseComplete

Yanıtın zaten gönderilip gönderilmediğini gösteren Boole değeri.

isResponseComplete: boolean

Özellik Değeri

boolean

payload

Yanıtın yükü, hizmet tarafındaki çağırana geri gönderilir.

payload: any

Özellik Değeri

any

requestId

Bu cihaz yöntemi çağrısı için hizmet tarafından sağlanan istek tanımlayıcısı.

requestId: string

Özellik Değeri

string

status

Yöntemin başarılı (200) olup olmadığını (200 olmayan başka bir sayı) gösteren durum kodu.

status: number

Özellik Değeri

number

Yöntem Ayrıntıları

send(number, any) 

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

Parametreler

status

number

payload

any

Döndürülenler

Promise<void>

send(number, any, ErrorCallback)

Yöntem çağrısının durumu olarak durum parametresini kullanarak cihaz yönteminin yanıtını temel alınan aktarım nesnesi aracılığıyla hizmete geri gönderir.

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

Parametreler

status

number

Hizmete geri gönderilecek sayısal durum kodu.

payload

any

[isteğe bağlı] Yöntem yanıtının yükü.

done

ErrorCallback

[isteğe bağlı] Yanıt hizmete geri gönderildikten sonra çağrılan geri çağırma işlevi. Hata oluşması durumunda işleve bağımsız değişken olarak bir hata nesnesi geçirilir. Geri arama belirtilmezse, bir Promise döndürülür.

send(number, ErrorCallback) 

function send(status: number, done: ErrorCallback)

Parametreler

status

number

done

ErrorCallback