com.google.api.client.googleapis.subscriptions.json

Class JsonSubscribeRequest

java.lang.Object

com.google.api.client.googleapis.subscriptions.SubscribeRequest

com.google.api.client.googleapis.subscriptions.json.JsonSubscribeRequest

public class JsonSubscribeRequest
extends SubscribeRequest

Subscribe JSON request.

Since:

1.14

Author:

Yaniv Inbar

Constructor Summary

Constructors

Constructor and Description
JsonSubscribeRequest(com.google.api.client.http.HttpRequest request, String notificationDeliveryMethod, com.google.api.client.json.JsonFactory jsonFactory)

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.json.JsonFactory	getJsonFactory() Returns the JSON factory.
void	queue(BatchRequest batchRequest, JsonBatchCallback<Void> callback) Queues the subscribe JSON request into the specified batch request container.
JsonSubscribeRequest	setClientToken(String clientToken) Sets the client token (an opaque string) provided by the client or null for none.
JsonSubscribeRequest	setNotificationDeliveryMethod(String notificationDeliveryMethod) Sets the notifications delivery method.
JsonSubscribeRequest	setSubscriptionId(String subscriptionId) Sets the subscription UUID provided by the client.
<N> JsonSubscribeRequest	withJsonNotificationCallback(SubscriptionStore subscriptionStore, Class<N> notificationCallbackClass, JsonNotificationCallback<N> jsonNotificationCallback) Sets the subscription store and JSON notification callback associated with this subscription.
JsonSubscribeRequest	withNotificationCallback(SubscriptionStore subscriptionStore, NotificationCallback notificationCallback) Sets the subscription store and notification callback associated with this subscription.
<N> JsonSubscribeRequest	withTypedNotificationCallback(SubscriptionStore subscriptionStore, Class<N> notificationCallbackClass, TypedNotificationCallback<N> typedNotificationCallback) Sets the subscription store and typed notification callback associated with this subscription.

Methods inherited from class com.google.api.client.googleapis.subscriptions.SubscribeRequest

execute, getClientToken, getNotificationCallback, getNotificationDeliveryMethod, getRequest, getSubscriptionId, getSubscriptionStore, queue

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonSubscribeRequest

public JsonSubscribeRequest(com.google.api.client.http.HttpRequest request,
                    String notificationDeliveryMethod,
                    com.google.api.client.json.JsonFactory jsonFactory)

Parameters:

request - HTTP GET request

notificationDeliveryMethod - notification delivery method

jsonFactory - JSON factory

Method Detail

withNotificationCallback

public JsonSubscribeRequest withNotificationCallback(SubscriptionStore subscriptionStore,
                                            NotificationCallback notificationCallback)

Description copied from class: SubscribeRequest

Sets the subscription store and notification callback associated with this subscription.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

withNotificationCallback in class SubscribeRequest

Parameters:

subscriptionStore - subscription store

notificationCallback - notification callback

withTypedNotificationCallback

public <N> JsonSubscribeRequest withTypedNotificationCallback(SubscriptionStore subscriptionStore,
                                                     Class<N> notificationCallbackClass,
                                                     TypedNotificationCallback<N> typedNotificationCallback)

Description copied from class: SubscribeRequest

Sets the subscription store and typed notification callback associated with this subscription.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

withTypedNotificationCallback in class SubscribeRequest

Parameters:

subscriptionStore - subscription store

notificationCallbackClass - data class the successful notification will be parsed into or Void.class to ignore the content

typedNotificationCallback - typed notification callback

setNotificationDeliveryMethod

public JsonSubscribeRequest setNotificationDeliveryMethod(String notificationDeliveryMethod)

Description copied from class: SubscribeRequest

Sets the notifications delivery method.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setNotificationDeliveryMethod in class SubscribeRequest

setClientToken

public JsonSubscribeRequest setClientToken(String clientToken)

Description copied from class: SubscribeRequest

Sets the client token (an opaque string) provided by the client or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setClientToken in class SubscribeRequest

setSubscriptionId

public JsonSubscribeRequest setSubscriptionId(String subscriptionId)

Description copied from class: SubscribeRequest

Sets the subscription UUID provided by the client.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setSubscriptionId in class SubscribeRequest

withJsonNotificationCallback

public <N> JsonSubscribeRequest withJsonNotificationCallback(SubscriptionStore subscriptionStore,
                                                    Class<N> notificationCallbackClass,
                                                    JsonNotificationCallback<N> jsonNotificationCallback)

Sets the subscription store and JSON notification callback associated with this subscription.

Parameters:

subscriptionStore - subscription store

notificationCallbackClass - data class the successful notification will be parsed into or Void.class to ignore the content

jsonNotificationCallback - JSON notification callback

getJsonFactory

public final com.google.api.client.json.JsonFactory getJsonFactory()

Returns the JSON factory.

queue

public final void queue(BatchRequest batchRequest,
         JsonBatchCallback<Void> callback)
                 throws IOException

Queues the subscribe JSON request into the specified batch request container.

Batched requests are then executed when BatchRequest.execute() is called.

Example usage:

     request.queue(batchRequest, new JsonBatchCallback<Void>() {

       public void onSuccess(Void ignored, HttpHeaders responseHeaders) {
         log("Success");
       }

       public void onFailure(GoogleJsonError e, HttpHeaders responseHeaders) {
         log(e.getMessage());
       }
     });
 

Parameters:

batchRequest - batch request container

callback - batch callback

Throws:

IOException