Package com.vk.api.sdk.queries.groups
Class GroupsEditQuery
- java.lang.Object
-
- com.vk.api.sdk.client.ApiRequest<R>
-
- com.vk.api.sdk.client.AbstractQueryBuilder<GroupsEditQuery,OkResponse>
-
- com.vk.api.sdk.queries.groups.GroupsEditQuery
-
public class GroupsEditQuery extends AbstractQueryBuilder<GroupsEditQuery,OkResponse>
Query for Groups.edit method
-
-
Constructor Summary
Constructors Constructor Description GroupsEditQuery(VkApiClient client, GroupActor actor, int groupId)Creates a AbstractQueryBuilder instance that can be used to build api request with various parametersGroupsEditQuery(VkApiClient client, UserActor actor, int groupId)Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GroupsEditQueryaccess(GroupAccess value)Community type.GroupsEditQueryaddresses(java.lang.Boolean value)Set addressesGroupsEditQueryageLimits(EditAgeLimits value)Community age limits.GroupsEditQueryarticles(java.lang.Boolean value)Set articlesGroupsEditQueryaudio(GroupAudio value)Audio settings.GroupsEditQuerycity(java.lang.Integer value)City of the community.GroupsEditQuerycontacts(java.lang.Boolean value)Contacts settings (for public pages only).GroupsEditQuerycountry(java.lang.Integer value)Country of the community.GroupsEditQuerydescription(java.lang.String value)Community description.GroupsEditQuerydocs(GroupDocs value)Documents settings.GroupsEditQueryemail(java.lang.String value)Organizer email (for events).protected java.util.List<java.lang.String>essentialKeys()Get list of required parameter namesGroupsEditQueryeventFinishDate(java.lang.Integer value)Event finish date in Unixtime format.GroupsEditQueryeventGroupId(java.lang.Integer value)Organizer community ID (for events only).GroupsEditQueryevents(java.lang.Boolean value)Events settings (for public pages only).GroupsEditQueryeventStartDate(java.lang.Integer value)Event start date in Unixtime format.protected GroupsEditQuerygetThis()Get reference to this objectprotected GroupsEditQuerygroupId(int value)Community ID.GroupsEditQuerylinks(java.lang.Boolean value)Links settings (for public pages only).GroupsEditQuerymainSection(java.lang.Integer value)Set main sectionGroupsEditQuerymarket(java.lang.Boolean value)Market settings.GroupsEditQuerymarketCity(java.lang.Integer... value)market_city Market delivery cities (if only one country is specified).GroupsEditQuerymarketCity(java.util.List<java.lang.Integer> value)Market delivery cities (if only one country is specified).GroupsEditQuerymarketComments(java.lang.Boolean value)Market comments settings.GroupsEditQuerymarketContact(java.lang.Integer value)Seller contact for market.GroupsEditQuerymarketCountry(java.lang.Integer... value)market_country Market delivery countries.GroupsEditQuerymarketCountry(java.util.List<java.lang.Integer> value)Market delivery countries.GroupsEditQuerymarketCurrency(GroupMarketCurrency value)Market currency settings.GroupsEditQuerymarketWiki(java.lang.Integer value)ID of a wiki page with market description.GroupsEditQuerymessages(java.lang.Boolean value)Community messages.GroupsEditQueryobsceneFilter(java.lang.Boolean value)Obscene expressions filter in comments.GroupsEditQueryobsceneStopwords(java.lang.Boolean value)Stopwords filter in comments.GroupsEditQueryobsceneWords(java.lang.String... value)obscene_words Keywords for stopwords filter.GroupsEditQueryobsceneWords(java.util.List<java.lang.String> value)Keywords for stopwords filter.GroupsEditQueryphone(java.lang.String value)Organizer phone number (for events).GroupsEditQueryphotos(GroupPhotos value)Photos settings.GroupsEditQueryplaces(java.lang.Boolean value)Places settings (for public pages only).GroupsEditQuerypublicCategory(java.lang.Integer value)Public page category ID.GroupsEditQuerypublicDate(java.lang.String value)Founding date of a company or organization owning the community in "dd.mm.YYYY" format.GroupsEditQuerypublicSubcategory(java.lang.Integer value)Public page subcategory ID.GroupsEditQueryrss(java.lang.String value)RSS feed address for import (available only to communities with special permission.GroupsEditQueryscreenName(java.lang.String value)Community screen name.GroupsEditQuerysecondarySection(java.lang.Integer value)Set secondary sectionGroupsEditQuerysubject(GroupSubject value)Community subject.GroupsEditQuerytitle(java.lang.String value)Community title.GroupsEditQuerytopics(GroupTopics value)Board topics settings.GroupsEditQueryvideo(GroupVideo value)Video settings.GroupsEditQuerywall(GroupWall value)Wall settings.GroupsEditQuerywebsite(java.lang.String value)Website that will be displayed in the community information field.GroupsEditQuerywiki(GroupWiki value)Wiki pages settings.-
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
-
-
-
-
Constructor Detail
-
GroupsEditQuery
public GroupsEditQuery(VkApiClient client, UserActor actor, int groupId)
Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters- Parameters:
client- VK API clientactor- actor with access tokengroupId- value of "group id" parameter. Minimum is 1.
-
GroupsEditQuery
public GroupsEditQuery(VkApiClient client, GroupActor actor, int groupId)
Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters- Parameters:
client- VK API clientactor- actor with access tokengroupId- value of "group id" parameter. Minimum is 1.
-
-
Method Detail
-
groupId
protected GroupsEditQuery groupId(int value)
Community ID.- Parameters:
value- value of "group id" parameter. Minimum is 1.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
title
public GroupsEditQuery title(java.lang.String value)
Community title.- Parameters:
value- value of "title" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
description
public GroupsEditQuery description(java.lang.String value)
Community description.- Parameters:
value- value of "description" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
screenName
public GroupsEditQuery screenName(java.lang.String value)
Community screen name.- Parameters:
value- value of "screen name" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
access
public GroupsEditQuery access(GroupAccess value)
Community type. Possible values: *'0' - open,, *'1' - closed,, *'2' - private.- Parameters:
value- value of "access" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
website
public GroupsEditQuery website(java.lang.String value)
Website that will be displayed in the community information field.- Parameters:
value- value of "website" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
subject
public GroupsEditQuery subject(GroupSubject value)
Community subject. Possible values: , *'1' - auto/moto,, *'2' - activity holidays,, *'3' - business,, *'4' - pets,, *'5' - health,, *'6' - dating and communication, , *'7' - games,, *'8' - IT (computers and software),, *'9' - cinema,, *'10' - beauty and fashion,, *'11' - cooking,, *'12' - art and culture,, *'13' - literature,, *'14' - mobile services and internet,, *'15' - music,, *'16' - science and technology,, *'17' - real estate,, *'18' - news and media,, *'19' - security,, *'20' - education,, *'21' - home and renovations,, *'22' - politics,, *'23' - food,, *'24' - industry,, *'25' - travel,, *'26' - work,, *'27' - entertainment,, *'28' - religion,, *'29' - family,, *'30' - sports,, *'31' - insurance,, *'32' - television,, *'33' - goods and services,, *'34' - hobbies,, *'35' - finance,, *'36' - photo,, *'37' - esoterics,, *'38' - electronics and appliances,, *'39' - erotic,, *'40' - humor,, *'41' - society, humanities,, *'42' - design and graphics.- Parameters:
value- value of "subject" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
email
public GroupsEditQuery email(java.lang.String value)
Organizer email (for events).- Parameters:
value- value of "email" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
phone
public GroupsEditQuery phone(java.lang.String value)
Organizer phone number (for events).- Parameters:
value- value of "phone" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
rss
public GroupsEditQuery rss(java.lang.String value)
RSS feed address for import (available only to communities with special permission. Contact vk.com/support to get it.- Parameters:
value- value of "rss" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
eventStartDate
public GroupsEditQuery eventStartDate(java.lang.Integer value)
Event start date in Unixtime format.- Parameters:
value- value of "event start date" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
eventFinishDate
public GroupsEditQuery eventFinishDate(java.lang.Integer value)
Event finish date in Unixtime format.- Parameters:
value- value of "event finish date" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
eventGroupId
public GroupsEditQuery eventGroupId(java.lang.Integer value)
Organizer community ID (for events only).- Parameters:
value- value of "event group id" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
publicCategory
public GroupsEditQuery publicCategory(java.lang.Integer value)
Public page category ID.- Parameters:
value- value of "public category" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
publicSubcategory
public GroupsEditQuery publicSubcategory(java.lang.Integer value)
Public page subcategory ID.- Parameters:
value- value of "public subcategory" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
publicDate
public GroupsEditQuery publicDate(java.lang.String value)
Founding date of a company or organization owning the community in "dd.mm.YYYY" format.- Parameters:
value- value of "public date" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
wall
public GroupsEditQuery wall(GroupWall value)
Wall settings. Possible values: *'0' - disabled,, *'1' - open,, *'2' - limited (groups and events only),, *'3' - closed (groups and events only).- Parameters:
value- value of "wall" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
topics
public GroupsEditQuery topics(GroupTopics value)
Board topics settings. Possbile values: , *'0' - disabled,, *'1' - open,, *'2' - limited (for groups and events only).- Parameters:
value- value of "topics" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
photos
public GroupsEditQuery photos(GroupPhotos value)
Photos settings. Possible values: *'0' - disabled,, *'1' - open,, *'2' - limited (for groups and events only).- Parameters:
value- value of "photos" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
video
public GroupsEditQuery video(GroupVideo value)
Video settings. Possible values: *'0' - disabled,, *'1' - open,, *'2' - limited (for groups and events only).- Parameters:
value- value of "video" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
audio
public GroupsEditQuery audio(GroupAudio value)
Audio settings. Possible values: *'0' - disabled,, *'1' - open,, *'2' - limited (for groups and events only).- Parameters:
value- value of "audio" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
links
public GroupsEditQuery links(java.lang.Boolean value)
Links settings (for public pages only). Possible values: *'0' - disabled,, *'1' - enabled.- Parameters:
value- value of "links" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
events
public GroupsEditQuery events(java.lang.Boolean value)
Events settings (for public pages only). Possible values: *'0' - disabled,, *'1' - enabled.- Parameters:
value- value of "events" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
places
public GroupsEditQuery places(java.lang.Boolean value)
Places settings (for public pages only). Possible values: *'0' - disabled,, *'1' - enabled.- Parameters:
value- value of "places" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
contacts
public GroupsEditQuery contacts(java.lang.Boolean value)
Contacts settings (for public pages only). Possible values: *'0' - disabled,, *'1' - enabled.- Parameters:
value- value of "contacts" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
docs
public GroupsEditQuery docs(GroupDocs value)
Documents settings. Possible values: *'0' - disabled,, *'1' - open,, *'2' - limited (for groups and events only).- Parameters:
value- value of "docs" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
wiki
public GroupsEditQuery wiki(GroupWiki value)
Wiki pages settings. Possible values: *'0' - disabled,, *'1' - open,, *'2' - limited (for groups and events only).- Parameters:
value- value of "wiki" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
messages
public GroupsEditQuery messages(java.lang.Boolean value)
Community messages. Possible values: *'0' — disabled,, *'1' — enabled.- Parameters:
value- value of "messages" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
articles
public GroupsEditQuery articles(java.lang.Boolean value)
Set articles- Parameters:
value- value of "articles" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
addresses
public GroupsEditQuery addresses(java.lang.Boolean value)
Set addresses- Parameters:
value- value of "addresses" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
ageLimits
public GroupsEditQuery ageLimits(EditAgeLimits value)
Community age limits. Possible values: *'1' — no limits,, *'2' — 16+,, *'3' — 18+.- Parameters:
value- value of "age limits" parameter. Minimum is 0. By default 1.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
market
public GroupsEditQuery market(java.lang.Boolean value)
Market settings. Possible values: *'0' - disabled,, *'1' - enabled.- Parameters:
value- value of "market" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
marketComments
public GroupsEditQuery marketComments(java.lang.Boolean value)
Market comments settings. Possible values: *'0' - disabled,, *'1' - enabled.- Parameters:
value- value of "market comments" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
marketCurrency
public GroupsEditQuery marketCurrency(GroupMarketCurrency value)
Market currency settings. Possbile values: , *'643' - Russian rubles,, *'980' - Ukrainian hryvnia,, *'398' - Kazakh tenge,, *'978' - Euro,, *'840' - US dollars- Parameters:
value- value of "market currency" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
marketContact
public GroupsEditQuery marketContact(java.lang.Integer value)
Seller contact for market. Set '0' for community messages.- Parameters:
value- value of "market contact" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
marketWiki
public GroupsEditQuery marketWiki(java.lang.Integer value)
ID of a wiki page with market description.- Parameters:
value- value of "market wiki" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
obsceneFilter
public GroupsEditQuery obsceneFilter(java.lang.Boolean value)
Obscene expressions filter in comments. Possible values: , *'0' - disabled,, *'1' - enabled.- Parameters:
value- value of "obscene filter" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
obsceneStopwords
public GroupsEditQuery obsceneStopwords(java.lang.Boolean value)
Stopwords filter in comments. Possible values: , *'0' - disabled,, *'1' - enabled.- Parameters:
value- value of "obscene stopwords" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
mainSection
public GroupsEditQuery mainSection(java.lang.Integer value)
Set main section- Parameters:
value- value of "main section" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
secondarySection
public GroupsEditQuery secondarySection(java.lang.Integer value)
Set secondary section- Parameters:
value- value of "secondary section" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
country
public GroupsEditQuery country(java.lang.Integer value)
Country of the community.- Parameters:
value- value of "country" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
city
public GroupsEditQuery city(java.lang.Integer value)
City of the community.- Parameters:
value- value of "city" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
obsceneWords
public GroupsEditQuery obsceneWords(java.lang.String... value)
obscene_words Keywords for stopwords filter.- Parameters:
value- value of "obscene words" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
obsceneWords
public GroupsEditQuery obsceneWords(java.util.List<java.lang.String> value)
Keywords for stopwords filter.- Parameters:
value- value of "obscene words" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
marketCountry
public GroupsEditQuery marketCountry(java.lang.Integer... value)
market_country Market delivery countries.- Parameters:
value- value of "market country" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
marketCountry
public GroupsEditQuery marketCountry(java.util.List<java.lang.Integer> value)
Market delivery countries.- Parameters:
value- value of "market country" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
marketCity
public GroupsEditQuery marketCity(java.lang.Integer... value)
market_city Market delivery cities (if only one country is specified).- Parameters:
value- value of "market city" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
marketCity
public GroupsEditQuery marketCity(java.util.List<java.lang.Integer> value)
Market delivery cities (if only one country is specified).- Parameters:
value- value of "market city" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
getThis
protected GroupsEditQuery getThis()
Description copied from class:AbstractQueryBuilderGet reference to this object- Specified by:
getThisin classAbstractQueryBuilder<GroupsEditQuery,OkResponse>- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
essentialKeys
protected java.util.List<java.lang.String> essentialKeys()
Description copied from class:AbstractQueryBuilderGet list of required parameter names- Specified by:
essentialKeysin classAbstractQueryBuilder<GroupsEditQuery,OkResponse>- Returns:
- list of names
-
-