com.restfb.batch
Class BatchRequest

java.lang.Object
  extended by com.restfb.batch.BatchRequest

public class BatchRequest
extends Object

Encapsulates a discrete part of an entire Facebook Batch API request.

Must be constructed by BatchRequest.BatchRequestBuilder.

Since:
1.6.5
Author:
Mark Allen
See Also:
BatchRequest.BatchRequestBuilder

Nested Class Summary
static class BatchRequest.BatchRequestBuilder
          Builder pattern implementation used to construct instances of BatchRequest.
 
Method Summary
 boolean equals(Object that)
           
 String getAttachedFiles()
          Names of any attached files for this call, for example "cat1, cat2" .
 String getBody()
          The request body, for example "message=Test status update".
 String getDependsOn()
          Another call in the current batch upon which this call depends, for example "get-friends".
 List<BatchHeader> getHeaders()
          HTTP Headers to be sent as part of this request.
 String getMethod()
          The HTTP method to use, for example "GET".
 String getName()
          The logical name for this request, for example "get-friends".
 String getRelativeUrl()
          The endpoint to hit, for example "me/friends?limit=10".
 int hashCode()
           
 boolean isOmitResponseOnSuccess()
          Will the batch response for this request be null?
 String toString()
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

hashCode

public int hashCode()
Overrides:
hashCode in class Object
See Also:
Object.hashCode()

equals

public boolean equals(Object that)
Overrides:
equals in class Object
See Also:
Object.equals(java.lang.Object)

toString

public String toString()
Overrides:
toString in class Object
See Also:
Object.toString()

getMethod

public String getMethod()
The HTTP method to use, for example "GET".

Returns:
The HTTP method to use.

getRelativeUrl

public String getRelativeUrl()
The endpoint to hit, for example "me/friends?limit=10".

Returns:
The endpoint to hit.

getBody

public String getBody()
The request body, for example "message=Test status update".

Returns:
The request body.

getAttachedFiles

public String getAttachedFiles()
Names of any attached files for this call, for example "cat1, cat2" .

Returns:
Names of any attached files for this call.

getName

public String getName()
The logical name for this request, for example "get-friends".

Returns:
The logical name for this request.

getDependsOn

public String getDependsOn()
Another call in the current batch upon which this call depends, for example "get-friends".

Returns:
Another call in the current batch upon which this call depends.

isOmitResponseOnSuccess

public boolean isOmitResponseOnSuccess()
Will the batch response for this request be null?

Returns:
true if the batch response for this request will be null, false otherwise.

getHeaders

public List<BatchHeader> getHeaders()
HTTP Headers to be sent as part of this request.

Returns:
HTTP Headers to be sent as part of this request.


RestFB 1.6.8. Copyright © 2010-2011 Mark Allen. All Rights Reserved.