69 строки
6.7 KiB
YAML
69 строки
6.7 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.sdk.iot.device.DeviceTwin.DeviceMethod"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.DeviceTwin.DeviceMethod"
|
|
name: "DeviceMethod"
|
|
nameWithType: "DeviceMethod"
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public final class **DeviceMethod**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.sdk.iot.device.DeviceTwin.DeviceMethod.DeviceMethod(com.microsoft.azure.sdk.iot.device.DeviceIO,com.microsoft.azure.sdk.iot.device.DeviceClientConfig,com.microsoft.azure.sdk.iot.device.IotHubEventCallback,java.lang.Object)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.DeviceTwin.DeviceMethod.DeviceMethod(DeviceIO deviceIO, DeviceClientConfig config, IotHubEventCallback deviceMethodStatusCallback, Object deviceMethodStatusCallbackContext)"
|
|
name: "DeviceMethod(DeviceIO deviceIO, DeviceClientConfig config, IotHubEventCallback deviceMethodStatusCallback, Object deviceMethodStatusCallbackContext)"
|
|
nameWithType: "DeviceMethod.DeviceMethod(DeviceIO deviceIO, DeviceClientConfig config, IotHubEventCallback deviceMethodStatusCallback, Object deviceMethodStatusCallbackContext)"
|
|
summary: "This constructor creates an instance of device method class which helps facilitate the interation for device methods between the user and Iot<wbr>Hub."
|
|
parameters:
|
|
- description: "Device client object for this connection instance for the device. Cannot be <code>null</code>"
|
|
name: "deviceIO"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.device.DeviceIO?alt=com.microsoft.azure.sdk.iot.device.DeviceIO&text=DeviceIO\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Device client configuration Cannot be <code>null</code>"
|
|
name: "config"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.device.DeviceClientConfig?alt=com.microsoft.azure.sdk.iot.device.DeviceClientConfig&text=DeviceClientConfig\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Callback to provide status for device method state with IotHub. Cannot be <code>null</code>."
|
|
name: "deviceMethodStatusCallback"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.device.IotHubEventCallback?alt=com.microsoft.azure.sdk.iot.device.IotHubEventCallback&text=IotHubEventCallback\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Context to be passed when device method status is invoked. Can be <code>null</code>"
|
|
name: "deviceMethodStatusCallbackContext"
|
|
type: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DeviceMethod(DeviceIO deviceIO, DeviceClientConfig config, IotHubEventCallback deviceMethodStatusCallback, Object deviceMethodStatusCallbackContext)"
|
|
exceptions:
|
|
- description: "This exception is thrown if either deviceIO or config or deviceMethodStatusCallback are null"
|
|
type: "<xref href=\"java.lang.IllegalArgumentException?alt=java.lang.IllegalArgumentException&text=IllegalArgumentException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "This constructor creates an instance of device method class which helps facilitate the interation for device methods between the user and IotHub."
|
|
methods:
|
|
- uid: "com.microsoft.azure.sdk.iot.device.DeviceTwin.DeviceMethod.subscribeToDeviceMethod(com.microsoft.azure.sdk.iot.device.DeviceTwin.DeviceMethodCallback,java.lang.Object)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.DeviceTwin.DeviceMethod.subscribeToDeviceMethod(DeviceTwin.DeviceMethodCallback deviceMethodCallback, Object deviceMethodCallbackContext)"
|
|
name: "subscribeToDeviceMethod(DeviceTwin.DeviceMethodCallback deviceMethodCallback, Object deviceMethodCallbackContext)"
|
|
nameWithType: "DeviceMethod.subscribeToDeviceMethod(DeviceTwin.DeviceMethodCallback deviceMethodCallback, Object deviceMethodCallbackContext)"
|
|
summary: "A method which subscribes to receive device method invocation for the user with the Iot<wbr>Hub."
|
|
parameters:
|
|
- description: "Callback where upon receiving the request the\n invoke a method shall be triggered."
|
|
name: "deviceMethodCallback"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.device.DeviceTwin.DeviceMethodCallback?alt=com.microsoft.azure.sdk.iot.device.DeviceTwin.DeviceMethodCallback&text=DeviceMethodCallback\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Context to be passed on when invoking the\n callback."
|
|
name: "deviceMethodCallbackContext"
|
|
type: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void subscribeToDeviceMethod(DeviceTwin.DeviceMethodCallback deviceMethodCallback, Object deviceMethodCallbackContext)"
|
|
exceptions:
|
|
- description: "This exception is thrown when deviceMethodCallback is provided null."
|
|
type: "<xref href=\"java.lang.IllegalArgumentException?alt=java.lang.IllegalArgumentException&text=IllegalArgumentException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "A method which subscribes to receive device method invocation for the user with the IotHub."
|
|
type: "class"
|
|
metadata: {}
|
|
package: "com.microsoft.azure.sdk.iot.device.DeviceTwin"
|
|
artifact: com.microsoft.azure.sdk.iot:iot-device-client:1.30.1
|