Package com.vk.api.sdk.queries.orders

Class OrdersCancelSubscriptionQuery

java.lang.Object

com.vk.api.sdk.client.ApiRequest<R>

com.vk.api.sdk.client.AbstractQueryBuilder<OrdersCancelSubscriptionQuery,CancelSubscriptionResponse>

com.vk.api.sdk.queries.orders.OrdersCancelSubscriptionQuery

public class OrdersCancelSubscriptionQuery
extends AbstractQueryBuilder<OrdersCancelSubscriptionQuery,CancelSubscriptionResponse>

Query for Orders.cancelSubscription method

Constructor Summary

Constructors

Constructor	Description
OrdersCancelSubscriptionQuery(VkApiClient client, ServiceActor actor, int userId, int subscriptionId)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected OrdersCancelSubscriptionQuery	getThis()	Get reference to this object
OrdersCancelSubscriptionQuery	pendingCancel(java.lang.Boolean value)	Set pending cancel
protected OrdersCancelSubscriptionQuery	subscriptionId(int value)	Set subscription id
protected OrdersCancelSubscriptionQuery	userId(int value)	Set user id

Methods inherited from class com.vk.api.sdk.client.AbstractQueryBuilder

accessToken, build, captchaKey, captchaSid, clientSecret, confirm, getBody, getMethod, getParams, lang, toString, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, version

Methods inherited from class com.vk.api.sdk.client.ApiRequest

execute, executeAsRaw, executeAsString, getClient, getGson, getHeaders, getResponseClass, getUrl, setHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

OrdersCancelSubscriptionQuery

public OrdersCancelSubscriptionQuery(VkApiClient client,
                                     ServiceActor actor,
                                     int userId,
                                     int subscriptionId)

Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

userId - value of "user id" parameter. Minimum is 1.

subscriptionId - value of "subscription id" parameter. Minimum is 0.

Method Detail

userId

protected OrdersCancelSubscriptionQuery userId(int value)

Set user id

Parameters:

value - value of "user id" parameter. Minimum is 1.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

subscriptionId

protected OrdersCancelSubscriptionQuery subscriptionId(int value)

Set subscription id

Parameters:

value - value of "subscription id" parameter. Minimum is 0.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

pendingCancel

public OrdersCancelSubscriptionQuery pendingCancel(java.lang.Boolean value)

Set pending cancel

Parameters:

value - value of "pending cancel" parameter. By default 0.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

getThis

protected OrdersCancelSubscriptionQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<OrdersCancelSubscriptionQuery,CancelSubscriptionResponse>

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

essentialKeys

protected java.util.List<java.lang.String> essentialKeys()

Description copied from class: AbstractQueryBuilder

Get list of required parameter names

Specified by:

essentialKeys in class AbstractQueryBuilder<OrdersCancelSubscriptionQuery,CancelSubscriptionResponse>

Returns:

list of names