ICall (iotize-device - Version unspecified)

Type Parameters:

T - Successful response body type.

All Superinterfaces:

java.lang.Cloneable

All Known Implementing Classes:

Call
```
public interface ICall<T>
extends java.lang.Cloneable
```
An invocation of a Retrofit method that sends a request to a webserver and returns a response. Each call yields its own HTTP request and response pair. Use clone() to make multiple calls with the same parameters to the same webserver; this may be used to implement polling or to retry a failed call.
Calls may be executed synchronously with execute(), or asynchronously with enqueue(com.iotize.android.device.device.api.service.builder.ICallback<T>). In either case the call can be canceled at any time with cancel(). A call that is busy writing its request or reading its response may receive a IOException; this is working as designed.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`cancel()` Cancel this call.
`ICall<T>`	`clone()` Create a new, identical call to this one which can be enqueued or executed even if this call has already been.
`void`	`enqueue(ICallback<T> callback)` Asynchronously send the request and notify `callback` of its response or if an error occurred talking to the server, creating the request, or processing the response.
`<any>`	`execute()` Synchronously send the request and return its response.
`T`	`get()` Helper function that calls execute() and body()
`boolean`	`isCanceled()` True if `cancel()` was called.
`boolean`	`isExecuted()` Returns true if this call has been either executed or enqueue(ICallback).
`Command`	`request()` The original request.

- Method Detail
  - execute
```
<any> execute()
       throws java.lang.Exception
```
    Synchronously send the request and return its response.
    
    Returns:
    
    the LWM2M response object
    
    Throws:
    
    java.io.IOException - if a problem occurred talking to the server.
    
    java.lang.RuntimeException - (and subclasses) if an unexpected error occurs creating the request or decoding the response.
    
    java.lang.Exception
  - enqueue
```
void enqueue(ICallback<T> callback)
```
    Asynchronously send the request and notify callback of its response or if an error occurred talking to the server, creating the request, or processing the response.
    
    Parameters:
    
    callback - the callback
  - isExecuted
```
boolean isExecuted()
```
    Returns true if this call has been either executed or enqueue(ICallback). It is an error to execute or enqueue a call more than once.
    
    Returns:
    
    true if request has been executed or enqueued
  - cancel
```
void cancel()
```
    Cancel this call. An attempt will be made to cancel in-flight calls, and if the call has not yet been executed it never will be.
  - isCanceled
```
boolean isCanceled()
```
    True if cancel() was called.
    
    Returns:
    
    true if request has been cancelled
  - clone
```
ICall<T> clone()
```
    Create a new, identical call to this one which can be enqueued or executed even if this call has already been.
    
    Returns:
    
    the cloned Call
  - request
```
Command request()
```
    The original request.
    
    Returns:
    
    the original request
  - get
```
T get()
throws java.lang.Exception
```
    Helper function that calls execute() and body()
    
    Returns:
    
    the decoded body data returned by the IoTize
    
    Throws:
    
    java.lang.Exception - any exception that could occurred during request or decoding the request

Interface ICall<T>

Method Summary

Method Detail

execute

enqueue

isExecuted

cancel

isCanceled

clone

request

get