com.vk.api.sdk.queries.likes.LikesGetListQuery Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk Show documentation
Show all versions of sdk Show documentation
Java library for VK API interaction, includes OAuth 2.0 authorization and API methods.
// Autogenerated from vk-api-schema. Please don't edit it manually.
package com.vk.api.sdk.queries.likes;
import com.vk.api.sdk.client.AbstractQueryBuilder;
import com.vk.api.sdk.client.VkApiClient;
import com.vk.api.sdk.client.actors.ServiceActor;
import com.vk.api.sdk.client.actors.UserActor;
import com.vk.api.sdk.objects.annotations.ApiParam;
import com.vk.api.sdk.objects.likes.GetListFilter;
import com.vk.api.sdk.objects.likes.GetListFriendsOnly;
import com.vk.api.sdk.objects.likes.Type;
import com.vk.api.sdk.objects.likes.responses.GetListResponse;
import java.util.Arrays;
import java.util.List;
/**
* Query for Likes.getList method
*/
public class LikesGetListQuery extends AbstractQueryBuilder {
/**
* Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
*
* @param client VK API client
* @param actor actor with access token
* @param type value of "type" parameter.
*/
public LikesGetListQuery(VkApiClient client, UserActor actor, Type type) {
super(client, "likes.getList", GetListResponse.class);
accessToken(actor.getAccessToken());
type(type);
}
/**
* Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
*
* @param client VK API client
* @param actor actor with access token
*/
public LikesGetListQuery(VkApiClient client, UserActor actor) {
super(client, "likes.getList", GetListResponse.class);
accessToken(actor.getAccessToken());
}
/**
* Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
*
* @param client VK API client
* @param actor actor with access token
* @param type value of "type" parameter.
*/
public LikesGetListQuery(VkApiClient client, ServiceActor actor, Type type) {
super(client, "likes.getList", GetListResponse.class);
accessToken(actor.getAccessToken());
clientSecret(actor.getClientSecret());
type(type);
}
/**
* Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
*
* @param client VK API client
* @param actor actor with access token
*/
public LikesGetListQuery(VkApiClient client, ServiceActor actor) {
super(client, "likes.getList", GetListResponse.class);
accessToken(actor.getAccessToken());
clientSecret(actor.getClientSecret());
}
/**
* , Object type: 'post' - post on user or community wall, 'comment' - comment on a wall post, 'photo' - photo, 'audio' - audio, 'video' - video, 'story' - story, 'note' - note, 'photo_comment' - comment on the photo, 'video_comment' - comment on the video, 'topic_comment' - comment in the discussion, 'sitepage' - page of the site where the [vk.com/dev/Like|Like widget] is installed
*
* @param value value of "type" parameter.
* @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
*/
@ApiParam("type")
public LikesGetListQuery type(Type value) {
return unsafeParam("type", value);
}
/**
* ID of the user, community, or application that owns the object. If the 'type' parameter is set as 'sitepage', the application ID is passed as 'owner_id'. Use negative value for a community id. If the 'type' parameter is not set, the 'owner_id' is assumed to be either the current user or the same application ID as if the 'type' parameter was set to 'sitepage'.
*
* @param value value of "owner id" parameter. Entity - owner
*
* @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
*/
@ApiParam("owner_id")
public LikesGetListQuery ownerId(Long value) {
return unsafeParam("owner_id", value);
}
/**
* Object ID. If 'type' is set as 'sitepage', 'item_id' can include the 'page_id' parameter value used during initialization of the [vk.com/dev/Like|Like widget].
*
* @param value value of "item id" parameter.
* @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
*/
@ApiParam("item_id")
public LikesGetListQuery itemId(Integer value) {
return unsafeParam("item_id", value);
}
/**
* URL of the page where the [vk.com/dev/Like|Like widget] is installed. Used instead of the 'item_id' parameter.
*
* @param value value of "page url" parameter.
* @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
*/
@ApiParam("page_url")
public LikesGetListQuery pageUrl(String value) {
return unsafeParam("page_url", value);
}
/**
* Filters to apply: 'likes' - returns information about all users who liked the object (default), 'copies' - returns information only about users who told their friends about the object
*
* @param value value of "filter" parameter.
* @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
*/
@ApiParam("filter")
public LikesGetListQuery filter(GetListFilter value) {
return unsafeParam("filter", value);
}
/**
* Specifies which users are returned: '1' - to return only the current user's friends, '0' - to return all users (default)
*
* @param value value of "friends only" parameter. By default 0.
* @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
*/
@ApiParam("friends_only")
public LikesGetListQuery friendsOnly(GetListFriendsOnly value) {
return unsafeParam("friends_only", value);
}
/**
* Specifies whether extended information will be returned. '1' - to return extended information about users and communities from the 'Likes' list, '0' - to return no additional information (default)
*
* @param value value of "extended" parameter.
* @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
*/
@ApiParam("extended")
public LikesGetListQuery extended(Boolean value) {
return unsafeParam("extended", value);
}
/**
* Offset needed to select a specific subset of users.
*
* @param value value of "offset" parameter. Minimum is 0.
* @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
*/
@ApiParam("offset")
public LikesGetListQuery offset(Integer value) {
return unsafeParam("offset", value);
}
/**
* Number of user IDs to return (maximum '1000'). Default is '100' if 'friends_only' is set to '0', otherwise, the default is '10' if 'friends_only' is set to '1'.
*
* @param value value of "count" parameter. Maximum is 1000. Minimum is 0.
* @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
*/
@ApiParam("count")
public LikesGetListQuery count(Integer value) {
return unsafeParam("count", value);
}
/**
* Set skip own
*
* @param value value of "skip own" parameter.
* @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
*/
@ApiParam("skip_own")
public LikesGetListQuery skipOwn(Boolean value) {
return unsafeParam("skip_own", value);
}
/**
* fields
* Set fields
*
* @param value value of "fields" parameter.
* @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
*/
@ApiParam("fields")
public LikesGetListQuery fields(String... value) {
return unsafeParam("fields", value);
}
/**
* Set fields
*
* @param value value of "fields" parameter.
* @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
*/
@ApiParam("fields")
public LikesGetListQuery fields(List value) {
return unsafeParam("fields", value);
}
@Override
protected LikesGetListQuery getThis() {
return this;
}
@Override
protected List essentialKeys() {
return Arrays.asList("type", "access_token");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy