Package com.vk.api.sdk.queries.users

Class UsersReportQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<UsersReportQuery,OkResponse>

com.vk.api.sdk.queries.users.UsersReportQuery

public class UsersReportQuery
extends AbstractQueryBuilder<UsersReportQuery,OkResponse>

Query for Users.report method

Constructor Summary

Constructors

Constructor	Description
UsersReportQuery(VkApiClient client, UserActor actor, int userId, ReportType type)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
UsersReportQuery	comment(java.lang.String value)	Comment describing the complaint.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected UsersReportQuery	getThis()	Get reference to this object
protected UsersReportQuery	type(ReportType value)	Type of complaint: 'porn' - pornography, 'spam' - spamming, 'insult' - abusive behavior, 'advertisement' - disruptive advertisements
protected UsersReportQuery	userId(int value)	ID of the user about whom a complaint is being made.

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

UsersReportQuery

public UsersReportQuery(VkApiClient client,
                        UserActor actor,
                        int userId,
                        ReportType type)

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.

type - value of "type" parameter.

Method Detail

userId

protected UsersReportQuery userId(int value)

ID of the user about whom a complaint is being made.

Parameters:

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

Returns:

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

type

protected UsersReportQuery type(ReportType value)

Type of complaint: 'porn' - pornography, 'spam' - spamming, 'insult' - abusive behavior, 'advertisement' - disruptive advertisements

Parameters:

value - value of "type" parameter.

Returns:

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

comment

public UsersReportQuery comment(java.lang.String value)

Comment describing the complaint.

Parameters:

value - value of "comment" parameter.

Returns:

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

getThis

protected UsersReportQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<UsersReportQuery,OkResponse>

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<UsersReportQuery,OkResponse>

Returns:

list of names