Package com.restfb.batch

Class BatchRequest.BatchRequestBuilder

java.lang.Object

com.restfb.batch.BatchRequest.BatchRequestBuilder

Enclosing class:

BatchRequest

public static class BatchRequest.BatchRequestBuilder
extends Object

Builder pattern implementation used to construct instances of BatchRequest.

See the Facebook Batch API documentation for more details on what a batch request looks like.

Since:

1.6.5

Author:

Mark Allen

Constructor Summary

Constructors

Constructor	Description
BatchRequestBuilder(String relativeUrl)	Creates a batch request builder using the provided FB endpoint.

Method Summary

Modifier and Type	Method	Description
BatchRequest.BatchRequestBuilder	attachedFiles(String attachedFiles)	Sets the comma-delimited names of any attached files for this builder, for example "cat1, cat2".
BatchRequest.BatchRequestBuilder	body(Parameter... parameters)	Sets the request body parameters for the request generated by this builder, for example Parameter.with("message", "Test status update").
BatchRequest	build()	Generates an instance of BatchRequest.
BatchRequest.BatchRequestBuilder	dependsOn(String dependsOn)	Specifies if the request generated by this builder depends on the completion of another call in the current batch, for example "first".
BatchRequest.BatchRequestBuilder	headers(BatchHeader... headers)	Sets the list of HTTP headers for the request generated by this builder.
BatchRequest.BatchRequestBuilder	method(String method)	Sets the HTTP method for the request generated by this builder, for example "POST" (GET is the default value for this builder).
BatchRequest.BatchRequestBuilder	name(String name)	Sets the logical name for the request generated by this builder.
BatchRequest.BatchRequestBuilder	omitResponseOnSuccess(boolean omitResponseOnSuccess)	To make sure FB returns JSON in the event that this builder's request completes successfully, set this to false.
BatchRequest.BatchRequestBuilder	parameters(Parameter... parameters)	Specifies URL parameters for the request generated by this builder.

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchRequestBuilder

public BatchRequestBuilder(String relativeUrl)

Creates a batch request builder using the provided FB endpoint.

You can explicitly specify URL parameters here, or use parameters(Parameter...) instead if you prefer to have the query string constructed programmatically.

Parameters:

relativeUrl - The endpoint to hit, for example "me/friends".

Method Detail

method

public BatchRequest.BatchRequestBuilder method(String method)

Sets the HTTP method for the request generated by this builder, for example "POST" (GET is the default value for this builder).

Parameters:

method - The HTTP method.

Returns:

This builder.

name

public BatchRequest.BatchRequestBuilder name(String name)

Sets the logical name for the request generated by this builder. Useful for specifying dependencies between operations - the generated request can be referenced by name.

Parameters:

name - The logical name of the request generated by this builder.

Returns:

This builder.

headers

public BatchRequest.BatchRequestBuilder headers(BatchHeader... headers)

Sets the list of HTTP headers for the request generated by this builder.

Parameters:

headers - The HTTP headers.

Returns:

This builder.

body

public BatchRequest.BatchRequestBuilder body(Parameter... parameters)

Sets the request body parameters for the request generated by this builder, for example Parameter.with("message", "Test status update").

Parameters:

parameters - The request body parameters.

Returns:

This builder.

attachedFiles

public BatchRequest.BatchRequestBuilder attachedFiles(String attachedFiles)

Sets the comma-delimited names of any attached files for this builder, for example "cat1, cat2".

Parameters:

attachedFiles - The names of any attached files for this builder.

Returns:

This builder.

dependsOn

public BatchRequest.BatchRequestBuilder dependsOn(String dependsOn)

Specifies if the request generated by this builder depends on the completion of another call in the current batch, for example "first".

Parameters:

dependsOn - A reference to another request in the batch that this builder's request depends on.

Returns:

This builder.

omitResponseOnSuccess

public BatchRequest.BatchRequestBuilder omitResponseOnSuccess(boolean omitResponseOnSuccess)

To make sure FB returns JSON in the event that this builder's request completes successfully, set this to false.

Parameters:

omitResponseOnSuccess - Set this to false to make sure FB returns JSON in the event that this builder's request completes successfully,

Returns:

This builder.

parameters

public BatchRequest.BatchRequestBuilder parameters(Parameter... parameters)

Specifies URL parameters for the request generated by this builder.

Parameters:

parameters - The URL parameters.

Returns:

This builder.

build

public BatchRequest build()

Generates an instance of BatchRequest.

Returns:

An instance of BatchRequest.