DeviceMethodResponse class
Dem Benutzer wird ein DeviceMethodResponse -Objekt bereitgestellt, wobei jedes DeviceMethodRequest dem Benutzer das Erstellen und Senden einer gut formatierten Antwort an den Dienst für jeden Gerätemethodenaufruf ermöglicht. Eine Instanz dieser Klasse wird als zweiter Parameter an den über onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)registrierten Rückruf übergeben.
Konstruktoren
| Device |
Eigenschaften
| is |
Boolescher Wert, der angibt, ob die Antwort bereits gesendet wurde. |
| payload | Die Nutzlast der Antwort, die an den Aufrufer auf der Dienstseite zurückgesendet wird. |
| request |
Der vom Dienst für diesen Gerätemethodenaufruf bereitgestellte Anforderungsbezeichner. |
| status | Statuscode, der angibt, ob die Methode erfolgreich war (200) oder nicht (eine andere Zahl, die nicht 200 ist). |
Methoden
| send(number, any) | |
| send(number, any, Error |
Sendet die Antwort der Gerätemethode über das zugrunde liegende Transportobjekt zurück an den Dienst, wobei der Statusparameter als Status des Methodenaufrufs verwendet wird. |
| send(number, Error |
Details zum Konstruktor
DeviceMethodResponse(string, DeviceTransport)
new DeviceMethodResponse(requestId: string, transport: DeviceTransport)Parameter
- requestId
-
string
- transport
- DeviceTransport
Details zur Eigenschaft
isResponseComplete
Boolescher Wert, der angibt, ob die Antwort bereits gesendet wurde.
isResponseComplete: booleanEigenschaftswert
boolean
payload
Die Nutzlast der Antwort, die an den Aufrufer auf der Dienstseite zurückgesendet wird.
payload: anyEigenschaftswert
any
requestId
Der vom Dienst für diesen Gerätemethodenaufruf bereitgestellte Anforderungsbezeichner.
requestId: stringEigenschaftswert
string
status
Statuscode, der angibt, ob die Methode erfolgreich war (200) oder nicht (eine andere Zahl, die nicht 200 ist).
status: numberEigenschaftswert
number
Details zur Methode
send(number, any)
function send(status: number, payload?: any): Promise<void>Parameter
- status
-
number
- payload
-
any
Gibt zurück
Promise<void>
send(number, any, ErrorCallback)
Sendet die Antwort der Gerätemethode über das zugrunde liegende Transportobjekt zurück an den Dienst, wobei der Statusparameter als Status des Methodenaufrufs verwendet wird.
function send(status: number, payload?: any, done?: ErrorCallback)Parameter
- status
-
number
Ein numerischer Statuscode, der an den Dienst zurückgesendet werden soll.
- payload
-
any
[optional] Die Nutzlast der Methodenantwort.
- done
-
ErrorCallback
[optional] Eine Rückruffunktion, die aufgerufen wird, sobald die Antwort an den Dienst zurückgesendet wurde. Für den Fall, dass ein Fehler auftritt, wird ein Fehlerobjekt als Argument an die Funktion übergeben. Wenn kein Rückruf angegeben ist, wird eine Zusage zurückgegeben.
send(number, ErrorCallback)
function send(status: number, done: ErrorCallback)Parameter
- status
-
number
- done
-
ErrorCallback