Class: Vk::API::Groups::Methods::Edit

Inherits:
Schema::Method show all
Defined in:
lib/vk/api/groups/methods/edit.rb

Overview

Edits a community.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Groups::Methods::Edit

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :group_id (Integer) —

    Community ID.

  • :title (String) —

    Community title.

  • :description (String) —

    Community description.

  • :screen_name (String) —

    Community screen name.

  • :access (Integer) —

    Community type. Possible values:; *'0' – open;; *'1' – closed;; *'2' – private.

  • :website (String) —

    Website that will be displayed in the community information field.

  • :subject (String) —

    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.

  • :email (String) —

    Organizer email (for events).

  • :phone (String) —

    Organizer phone number (for events).

  • :rss (String) —

    RSS feed address for import (available only to communities with special permission. Contact vk.com/support to get it.

  • :event_start_date (Integer) —

    Event start date in Unixtime format.

  • :event_finish_date (Integer) —

    Event finish date in Unixtime format.

  • :event_group_id (Integer) —

    Organizer community ID (for events only).

  • :public_category (Integer) —

    Public page category ID.

  • :public_subcategory (Integer) —

    Public page subcategory ID.

  • :public_date (String) —

    Founding date of a company or organization owning the community in "dd.mm.YYYY" format.

  • :wall (Integer) —

    Wall settings. Possible values:; *'0' – disabled;; *'1' – open;; *'2' – limited (groups and events only);; *'3' – closed (groups and events only).;

  • :topics (Integer) —

    Board topics settings. Possbile values: ; *'0' – disabled;; *'1' – open;; *'2' – limited (for groups and events only).;

  • :photos (Integer) —

    Photos settings. Possible values:; *'0' – disabled;; *'1' – open;; *'2' – limited (for groups and events only).;

  • :video (Integer) —

    Video settings. Possible values:; *'0' – disabled;; *'1' – open;; *'2' – limited (for groups and events only).

  • :audio (Integer) —

    Audio settings. Possible values:; *'0' – disabled;; *'1' – open;; *'2' – limited (for groups and events only).

  • :links (Boolean) —

    Links settings (for public pages only). Possible values:; *'0' – disabled;; *'1' – enabled.;

  • :events (Boolean) —

    Events settings (for public pages only). Possible values:; *'0' – disabled;; *'1' – enabled.;

  • :places (Boolean) —

    Places settings (for public pages only). Possible values:; *'0' – disabled;; *'1' – enabled.;

  • :contacts (Boolean) —

    Contacts settings (for public pages only). Possible values:; *'0' – disabled;; *'1' – enabled.;

  • :docs (Integer) —

    Documents settings. Possible values:; *'0' – disabled;; *'1' – open;; *'2' – limited (for groups and events only).

  • :wiki (Integer) —

    Wiki pages settings. Possible values:; *'0' – disabled;; *'1' – open;; *'2' – limited (for groups and events only).

  • :messages (Boolean) —

    Community messages. Possible values:; *'0' — disabled;; *'1' — enabled.

  • :age_limits (Integer) —

    Community age limits. Possible values:; *'1' — no limits;; *'2' — 16+;; *'3' — 18+.

  • :market (Boolean) —

    Market settings. Possible values:; *'0' – disabled;; *'1' – enabled.

  • :market_comments (Boolean) —

    market comments settings. Possible values:; *'0' – disabled;; *'1' – enabled.

  • :market_country (Array) —

    Market delivery countries.

  • :market_city (Array) —

    Market delivery cities (if only one country is specified).

  • :market_currency (Integer) —

    Market currency settings. Possbile values: ; *'643' – Russian rubles;; *'980' – Ukrainian hryvnia;; *'398' – Kazakh tenge;; *'978' – Euro;; *'840' – US dollars

  • :market_contact (Integer) —

    Seller contact for market.; Set '0' for community messages.

  • :market_wiki (Integer) —

    ID of a wiki page with market description.

  • :obscene_filter (Boolean) —

    Obscene expressions filter in comments. Possible values: ; *'0' – disabled;; *'1' – enabled.

  • :obscene_stopwords (Boolean) —

    Stopwords filter in comments. Possible values: ; *'0' – disabled;; *'1' – enabled.

  • :obscene_words (Array) —

    Keywords for stopwords filter.




# File 'lib/vk/api/groups/methods/edit.rb', line 15

Instance Method Details

#access ⇒ Integer

Returns Community type. Possible values:; *'0' – open;; *'1' – closed;; *'2' – private.

Returns:

  • (Integer) —

    Community type. Possible values:; *'0' – open;; *'1' – closed;; *'2' – private.



69
 
# File 'lib/vk/api/groups/methods/edit.rb', line 69

attribute :access, API::Types::Coercible::Int.optional.default(nil)

#age_limits ⇒ Integer

Returns Community age limits. Possible values:; *'1' — no limits;; *'2' — 16+;; *'3' — 18+.

Returns:

  • (Integer) —

    Community age limits. Possible values:; *'1' — no limits;; *'2' — 16+;; *'3' — 18+.



117
 
# File 'lib/vk/api/groups/methods/edit.rb', line 117

attribute :age_limits, API::Types::Coercible::Int.enum(1, 2, 3).optional.default(2)

#audio ⇒ Integer

Returns Audio settings. Possible values:; *'0' – disabled;; *'1' – open;; *'2' – limited (for groups and events only).

Returns:

  • (Integer) —

    Audio settings. Possible values:; *'0' – disabled;; *'1' – open;; *'2' – limited (for groups and events only).



101
 
# File 'lib/vk/api/groups/methods/edit.rb', line 101

attribute :audio, API::Types::Coercible::Int.optional.default(nil)

#contacts ⇒ Boolean

Returns Contacts settings (for public pages only). Possible values:; *'0' – disabled;; *'1' – enabled.;.

Returns:

  • (Boolean) —

    Contacts settings (for public pages only). Possible values:; *'0' – disabled;; *'1' – enabled.;



109
 
# File 'lib/vk/api/groups/methods/edit.rb', line 109

attribute :contacts, API::Types::Form::Bool.optional.default(nil)

#description ⇒ String

Returns Community description.

Returns:

  • (String) —

    Community description.



65
 
# File 'lib/vk/api/groups/methods/edit.rb', line 65

attribute :description, API::Types::Coercible::String.optional.default(nil)

#docs ⇒ Integer

Returns Documents settings. Possible values:; *'0' – disabled;; *'1' – open;; *'2' – limited (for groups and events only).

Returns:

  • (Integer) —

    Documents settings. Possible values:; *'0' – disabled;; *'1' – open;; *'2' – limited (for groups and events only).



111
 
# File 'lib/vk/api/groups/methods/edit.rb', line 111

attribute :docs, API::Types::Coercible::Int.optional.default(nil)

#email ⇒ String

Returns Organizer email (for events).

Returns:

  • (String) —

    Organizer email (for events).



75
 
# File 'lib/vk/api/groups/methods/edit.rb', line 75

attribute :email, API::Types::Coercible::String.optional.default(nil)

#event_finish_date ⇒ Integer

Returns Event finish date in Unixtime format.

Returns:

  • (Integer) —

    Event finish date in Unixtime format.



83
 
# File 'lib/vk/api/groups/methods/edit.rb', line 83

attribute :event_finish_date, API::Types::Coercible::Int.optional.default(nil)

#event_group_id ⇒ Integer

Returns Organizer community ID (for events only).

Returns:

  • (Integer) —

    Organizer community ID (for events only).



85
 
# File 'lib/vk/api/groups/methods/edit.rb', line 85

attribute :event_group_id, API::Types::Coercible::Int.optional.default(nil)

#event_start_date ⇒ Integer

Returns Event start date in Unixtime format.

Returns:

  • (Integer) —

    Event start date in Unixtime format.



81
 
# File 'lib/vk/api/groups/methods/edit.rb', line 81

attribute :event_start_date, API::Types::Coercible::Int.optional.default(nil)

#events ⇒ Boolean

Returns Events settings (for public pages only). Possible values:; *'0' – disabled;; *'1' – enabled.;.

Returns:

  • (Boolean) —

    Events settings (for public pages only). Possible values:; *'0' – disabled;; *'1' – enabled.;



105
 
# File 'lib/vk/api/groups/methods/edit.rb', line 105

attribute :events, API::Types::Form::Bool.optional.default(nil)

#group_id ⇒ Integer

Returns Community ID.

Returns:

  • (Integer) —

    Community ID.



61
 
# File 'lib/vk/api/groups/methods/edit.rb', line 61

attribute :group_id, API::Types::Coercible::Int

#links ⇒ Boolean

Returns Links settings (for public pages only). Possible values:; *'0' – disabled;; *'1' – enabled.;.

Returns:

  • (Boolean) —

    Links settings (for public pages only). Possible values:; *'0' – disabled;; *'1' – enabled.;



103
 
# File 'lib/vk/api/groups/methods/edit.rb', line 103

attribute :links, API::Types::Form::Bool.optional.default(nil)

#market ⇒ Boolean

Returns Market settings. Possible values:; *'0' – disabled;; *'1' – enabled.

Returns:

  • (Boolean) —

    Market settings. Possible values:; *'0' – disabled;; *'1' – enabled.



119
 
# File 'lib/vk/api/groups/methods/edit.rb', line 119

attribute :market, API::Types::Form::Bool.optional.default(nil)

#market_city ⇒ Array

Returns Market delivery cities (if only one country is specified).

Returns:

  • (Array) —

    Market delivery cities (if only one country is specified).



125
 
# File 'lib/vk/api/groups/methods/edit.rb', line 125

attribute :market_city, API::Types::Coercible::Array.member(API::Types::Coercible::Int).constrained(max_size: 10).optional.default(nil)

#market_comments ⇒ Boolean

Returns market comments settings. Possible values:; *'0' – disabled;; *'1' – enabled.

Returns:

  • (Boolean) —

    market comments settings. Possible values:; *'0' – disabled;; *'1' – enabled.



121
 
# File 'lib/vk/api/groups/methods/edit.rb', line 121

attribute :market_comments, API::Types::Form::Bool.optional.default(nil)

#market_contact ⇒ Integer

Returns Seller contact for market.; Set '0' for community messages.

Returns:

  • (Integer) —

    Seller contact for market.; Set '0' for community messages.



129
 
# File 'lib/vk/api/groups/methods/edit.rb', line 129

attribute :market_contact, API::Types::Coercible::Int.optional.default(nil)

#market_country ⇒ Array

Returns Market delivery countries.

Returns:

  • (Array) —

    Market delivery countries.



123
 
# File 'lib/vk/api/groups/methods/edit.rb', line 123

attribute :market_country, API::Types::Coercible::Array.member(API::Types::Coercible::Int).constrained(max_size: 10).optional.default(nil)

#market_currency ⇒ Integer

Returns Market currency settings. Possbile values: ; *'643' – Russian rubles;; *'980' – Ukrainian hryvnia;; *'398' – Kazakh tenge;; *'978' – Euro;; *'840' – US dollars.

Returns:

  • (Integer) —

    Market currency settings. Possbile values: ; *'643' – Russian rubles;; *'980' – Ukrainian hryvnia;; *'398' – Kazakh tenge;; *'978' – Euro;; *'840' – US dollars



127
 
# File 'lib/vk/api/groups/methods/edit.rb', line 127

attribute :market_currency, API::Types::Coercible::Int.optional.default(nil)

#market_wiki ⇒ Integer

Returns ID of a wiki page with market description.

Returns:

  • (Integer) —

    ID of a wiki page with market description.



131
 
# File 'lib/vk/api/groups/methods/edit.rb', line 131

attribute :market_wiki, API::Types::Coercible::Int.optional.default(nil)

#messages ⇒ Boolean

Returns Community messages. Possible values:; *'0' — disabled;; *'1' — enabled.

Returns:

  • (Boolean) —

    Community messages. Possible values:; *'0' — disabled;; *'1' — enabled.



115
 
# File 'lib/vk/api/groups/methods/edit.rb', line 115

attribute :messages, API::Types::Form::Bool.optional.default(nil)

#obscene_filter ⇒ Boolean

Returns Obscene expressions filter in comments. Possible values: ; *'0' – disabled;; *'1' – enabled.

Returns:

  • (Boolean) —

    Obscene expressions filter in comments. Possible values: ; *'0' – disabled;; *'1' – enabled.



133
 
# File 'lib/vk/api/groups/methods/edit.rb', line 133

attribute :obscene_filter, API::Types::Form::Bool.optional.default(nil)

#obscene_stopwords ⇒ Boolean

Returns Stopwords filter in comments. Possible values: ; *'0' – disabled;; *'1' – enabled.

Returns:

  • (Boolean) —

    Stopwords filter in comments. Possible values: ; *'0' – disabled;; *'1' – enabled.



135
 
# File 'lib/vk/api/groups/methods/edit.rb', line 135

attribute :obscene_stopwords, API::Types::Form::Bool.optional.default(nil)

#obscene_words ⇒ Array

Returns Keywords for stopwords filter.

Returns:

  • (Array) —

    Keywords for stopwords filter.



137
 
# File 'lib/vk/api/groups/methods/edit.rb', line 137

attribute :obscene_words, API::Types::Coercible::Array.member(API::Types::Coercible::String).optional.default(nil)

#phone ⇒ String

Returns Organizer phone number (for events).

Returns:

  • (String) —

    Organizer phone number (for events).



77
 
# File 'lib/vk/api/groups/methods/edit.rb', line 77

attribute :phone, API::Types::Coercible::String.optional.default(nil)

#photos ⇒ Integer

Returns Photos settings. Possible values:; *'0' – disabled;; *'1' – open;; *'2' – limited (for groups and events only).;.

Returns:

  • (Integer) —

    Photos settings. Possible values:; *'0' – disabled;; *'1' – open;; *'2' – limited (for groups and events only).;



97
 
# File 'lib/vk/api/groups/methods/edit.rb', line 97

attribute :photos, API::Types::Coercible::Int.optional.default(nil)

#places ⇒ Boolean

Returns Places settings (for public pages only). Possible values:; *'0' – disabled;; *'1' – enabled.;.

Returns:

  • (Boolean) —

    Places settings (for public pages only). Possible values:; *'0' – disabled;; *'1' – enabled.;



107
 
# File 'lib/vk/api/groups/methods/edit.rb', line 107

attribute :places, API::Types::Form::Bool.optional.default(nil)

#public_category ⇒ Integer

Returns Public page category ID.

Returns:

  • (Integer) —

    Public page category ID.



87
 
# File 'lib/vk/api/groups/methods/edit.rb', line 87

attribute :public_category, API::Types::Coercible::Int.optional.default(nil)

#public_date ⇒ String

Returns Founding date of a company or organization owning the community in "dd.mm.YYYY" format.

Returns:

  • (String) —

    Founding date of a company or organization owning the community in "dd.mm.YYYY" format.



91
 
# File 'lib/vk/api/groups/methods/edit.rb', line 91

attribute :public_date, API::Types::Coercible::String.optional.default(nil)

#public_subcategory ⇒ Integer

Returns Public page subcategory ID.

Returns:

  • (Integer) —

    Public page subcategory ID.



89
 
# File 'lib/vk/api/groups/methods/edit.rb', line 89

attribute :public_subcategory, API::Types::Coercible::Int.optional.default(nil)

#rss ⇒ String

Returns RSS feed address for import (available only to communities with special permission. Contact vk.com/support to get it.

Returns:

  • (String) —

    RSS feed address for import (available only to communities with special permission. Contact vk.com/support to get it.



79
 
# File 'lib/vk/api/groups/methods/edit.rb', line 79

attribute :rss, API::Types::Coercible::String.optional.default(nil)

#screen_name ⇒ String

Returns Community screen name.

Returns:

  • (String) —

    Community screen name.



67
 
# File 'lib/vk/api/groups/methods/edit.rb', line 67

attribute :screen_name, API::Types::Coercible::String.optional.default(nil)

#subject ⇒ String

Returns 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.

Returns:

  • (String) —

    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.



73
 
# File 'lib/vk/api/groups/methods/edit.rb', line 73

attribute :subject, API::Types::Coercible::String.optional.default(nil)

#title ⇒ String

Returns Community title.

Returns:

  • (String) —

    Community title.



63
 
# File 'lib/vk/api/groups/methods/edit.rb', line 63

attribute :title, API::Types::Coercible::String.optional.default(nil)

#topics ⇒ Integer

Returns Board topics settings. Possbile values: ; *'0' – disabled;; *'1' – open;; *'2' – limited (for groups and events only).;.

Returns:

  • (Integer) —

    Board topics settings. Possbile values: ; *'0' – disabled;; *'1' – open;; *'2' – limited (for groups and events only).;



95
 
# File 'lib/vk/api/groups/methods/edit.rb', line 95

attribute :topics, API::Types::Coercible::Int.optional.default(nil)

#video ⇒ Integer

Returns Video settings. Possible values:; *'0' – disabled;; *'1' – open;; *'2' – limited (for groups and events only).

Returns:

  • (Integer) —

    Video settings. Possible values:; *'0' – disabled;; *'1' – open;; *'2' – limited (for groups and events only).



99
 
# File 'lib/vk/api/groups/methods/edit.rb', line 99

attribute :video, API::Types::Coercible::Int.optional.default(nil)

#wall ⇒ Integer

Returns Wall settings. Possible values:; *'0' – disabled;; *'1' – open;; *'2' – limited (groups and events only);; *'3' – closed (groups and events only).;.

Returns:

  • (Integer) —

    Wall settings. Possible values:; *'0' – disabled;; *'1' – open;; *'2' – limited (groups and events only);; *'3' – closed (groups and events only).;



93
 
# File 'lib/vk/api/groups/methods/edit.rb', line 93

attribute :wall, API::Types::Coercible::Int.optional.default(nil)

#website ⇒ String

Returns Website that will be displayed in the community information field.

Returns:

  • (String) —

    Website that will be displayed in the community information field.



71
 
# File 'lib/vk/api/groups/methods/edit.rb', line 71

attribute :website, API::Types::Coercible::String.optional.default(nil)

#wiki ⇒ Integer

Returns Wiki pages settings. Possible values:; *'0' – disabled;; *'1' – open;; *'2' – limited (for groups and events only).

Returns:

  • (Integer) —

    Wiki pages settings. Possible values:; *'0' – disabled;; *'1' – open;; *'2' – limited (for groups and events only).



113
 
# File 'lib/vk/api/groups/methods/edit.rb', line 113

attribute :wiki, API::Types::Coercible::Int.optional.default(nil)