Class: Vk::API::Groups::Group

Inherits:

Schema::Object

• Object
• Dry::Struct
• Schema::Object
• Vk::API::Groups::Group

Defined in:

lib/vk/api/groups/group.rb

Overview

See Also:

• https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

Direct Known Subclasses

GroupFull

Instance Method Summary

• #admin_level ⇒ Integer

  Level of current user's credentials as manager.

• #id ⇒ String

  Community ID.

• #is_admin ⇒ Integer

  Information whether current user is administrator.

• #is_closed ⇒ Integer

  Information whether community is closed.

• #is_member ⇒ API::Base::BoolInt

  Information whether current user is member.

• #name ⇒ String

  Community name.

• #photo_100 ⇒ String

  URL of square photo of the community with 100 pixels in width.

• #photo_200 ⇒ String

  URL of square photo of the community with 200 pixels in width.

• #photo_50 ⇒ String

  URL of square photo of the community with 50 pixels in width.

• #screen_name ⇒ String

  Domain of the community page.

• #type ⇒ String

  Community type.

Instance Method Details

#admin_level ⇒ Integer

Returns Level of current user's credentials as manager.

Returns:

• (Integer) —

  Level of current user's credentials as manager

# File 'lib/vk/api/groups/group.rb', line 23

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

#id ⇒ String

Returns Community ID.

Returns:

• (String) —

  Community ID

# File 'lib/vk/api/groups/group.rb', line 11

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

#is_admin ⇒ Integer

Returns Information whether current user is administrator.

Returns:

• (Integer) —

  Information whether current user is administrator

# File 'lib/vk/api/groups/group.rb', line 21

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

#is_closed ⇒ Integer

Returns Information whether community is closed.

Returns:

• (Integer) —

  Information whether community is closed

# File 'lib/vk/api/groups/group.rb', line 17

attribute :is_closed, API::Types::Coercible::Int.enum(0, 1, 2).optional.default(nil)

#is_member ⇒ API::Base::BoolInt

Returns Information whether current user is member.

Returns:

• (API::Base::BoolInt) —

  Information whether current user is member

# File 'lib/vk/api/groups/group.rb', line 25

attribute :is_member, API::Base::BoolInt.optional.default(nil)

#name ⇒ String

Returns Community name.

Returns:

• (String) —

  Community name

# File 'lib/vk/api/groups/group.rb', line 13

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

#photo_100 ⇒ String

Returns URL of square photo of the community with 100 pixels in width.

Returns:

• (String) —

  URL of square photo of the community with 100 pixels in width

# File 'lib/vk/api/groups/group.rb', line 29

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

#photo_200 ⇒ String

Returns URL of square photo of the community with 200 pixels in width.

Returns:

• (String) —

  URL of square photo of the community with 200 pixels in width

# File 'lib/vk/api/groups/group.rb', line 31

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

#photo_50 ⇒ String

Returns URL of square photo of the community with 50 pixels in width.

Returns:

• (String) —

  URL of square photo of the community with 50 pixels in width

# File 'lib/vk/api/groups/group.rb', line 27

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

#screen_name ⇒ String

Returns Domain of the community page.

Returns:

• (String) —

  Domain of the community page

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

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

#type ⇒ String

Returns Community type.

Returns:

• (String) —

  Community type

# File 'lib/vk/api/groups/group.rb', line 19

attribute :type, API::Types::Coercible::String.enum("group", "page", "event").optional.default(nil)