com.microsoft.azure.sdk.iot.service.devicetwin

Class DeviceMethod

java.lang.Object

com.microsoft.azure.sdk.iot.service.devicetwin.DeviceMethod

public class DeviceMethod
extends Object

DeviceMethod enables service client to directly invoke methods on various devices from service client.

Constructor Summary

Constructors

Constructor and Description
DeviceMethod()

Method Summary

Modifier and Type	Method and Description
static DeviceMethod	createFromConnectionString(String connectionString) Create a DeviceMethod instance from the information in the connection string.
MethodResult	invoke(String deviceId, String methodName, Long responseTimeoutInSeconds, Long connectTimeoutInSeconds, Object payload) Directly invokes a method on the device and return its result.
Job	scheduleDeviceMethod(String queryCondition, String methodName, Long responseTimeoutInSeconds, Long connectTimeoutInSeconds, Object payload, Date startTimeUtc, long maxExecutionTimeInSeconds) Creates a new Job to invoke method on one or multiple devices

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeviceMethod

public DeviceMethod()

Method Detail

createFromConnectionString

public static DeviceMethod createFromConnectionString(String connectionString)
                                               throws IOException

Create a DeviceMethod instance from the information in the connection string.

Parameters:

connectionString - is the IoTHub connection string.

Returns:

an instance of the DeviceMethod.

Throws:

IOException - This exception is thrown if the object creation failed

invoke

public MethodResult invoke(String deviceId,
                           String methodName,
                           Long responseTimeoutInSeconds,
                           Long connectTimeoutInSeconds,
                           Object payload)
                    throws IotHubException,
                           IOException

Directly invokes a method on the device and return its result.

Parameters:

deviceId - is the device identification.

methodName - is the name of the method that shall be invoked on the device.

responseTimeoutInSeconds - is the maximum waiting time for a response from the device in seconds.

connectTimeoutInSeconds - is the maximum waiting time for a response from the connection in seconds.

payload - is the the method parameter

Returns:

the status and payload resulted from the method invoke

Throws:

IotHubException - This exception is thrown if the response verification failed

IOException - This exception is thrown if the IO operation failed

scheduleDeviceMethod

public Job scheduleDeviceMethod(String queryCondition,
                                String methodName,
                                Long responseTimeoutInSeconds,
                                Long connectTimeoutInSeconds,
                                Object payload,
                                Date startTimeUtc,
                                long maxExecutionTimeInSeconds)
                         throws IOException,
                                IotHubException

Creates a new Job to invoke method on one or multiple devices

Parameters:

queryCondition - Query condition to evaluate which devices to run the job on. It can be null or empty

methodName - Method name to be invoked

responseTimeoutInSeconds - Maximum interval of time, in seconds, that the Direct Method will wait for answer. It can be null.

connectTimeoutInSeconds - Maximum interval of time, in seconds, that the Direct Method will wait for the connection. It can be null.

payload - Object that contains the payload defined by the user. It can be null.

startTimeUtc - Date time in Utc to start the job

maxExecutionTimeInSeconds - Max execution time in seconds, i.e., ttl duration the job can run

Returns:

a Job class that represent this job on IotHub

Throws:

IOException - if the function contains invalid parameters

IotHubException - if the http request failed