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,BoolResponse>

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

public class OrdersCancelSubscriptionQuery
extends AbstractQueryBuilder<OrdersCancelSubscriptionQuery,BoolResponse>

Query for Orders.cancelSubscription method

Constructor Summary

Constructors

Constructor and Description
OrdersCancelSubscriptionQuery(VkApiClient client, ServiceActor actor) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
OrdersCancelSubscriptionQuery(VkApiClient client, ServiceActor actor, java.lang.Long userId, java.lang.Integer subscriptionId) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters

Method Summary

Modifier and Type	Method and 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
OrdersCancelSubscriptionQuery	subscriptionId(java.lang.Integer value) Set subscription id
OrdersCancelSubscriptionQuery	userId(java.lang.Long value) Set user id

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

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

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

addHeader, addHeaders, execute, executeAsRaw, executeAsString, executeAsStringWithReturningFullInfo, executeTypeable, executeTypeableWithoutRetry, executeWithoutRetry, getClient, getCookie, getGson, getHeaders, getResponseClass, getUrl, setCookie, setCookies, setHeaders, 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,
                                     java.lang.Long userId,
                                     java.lang.Integer subscriptionId)

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

Parameters:

client - VK API client

actor - actor with access token

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

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

OrdersCancelSubscriptionQuery

public OrdersCancelSubscriptionQuery(VkApiClient client,
                                     ServiceActor actor)

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

Parameters:

client - VK API client

actor - actor with access token

Method Detail

userId

public OrdersCancelSubscriptionQuery userId(java.lang.Long value)

Set user id

Parameters:

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

Returns:

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

subscriptionId

public OrdersCancelSubscriptionQuery subscriptionId(java.lang.Integer 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,BoolResponse>

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,BoolResponse>

Returns:

list of names