Class: Vk::API::Search::Hint

Inherits:

Schema::Object

• Object
• Dry::Struct
• Schema::Object
• Vk::API::Search::Hint

Defined in:

lib/vk/api/search/hint.rb

Overview

See Also:

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

Instance Method Summary

• #description ⇒ String

  Object description.

• #global ⇒ API::Base::BoolInt

  Information whether the object has been found globally.

• #group ⇒ API::Groups::Group
• #profile ⇒ API::Users::UserMin
• #section ⇒ String

  Section title.

• #type ⇒ String

  Object type.

Instance Method Details

#description ⇒ String

Returns Object description.

Returns:

• (String) —

  Object description

# File 'lib/vk/api/search/hint.rb', line 15

attribute :description, API::Types::Coercible::String

#global ⇒ API::Base::BoolInt

Returns Information whether the object has been found globally.

Returns:

• (API::Base::BoolInt) —

  Information whether the object has been found globally

# File 'lib/vk/api/search/hint.rb', line 17

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

#group ⇒ API::Groups::Group

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:

• (API::Groups::Group) —

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

# File 'lib/vk/api/search/hint.rb', line 19

attribute :group, Dry::Types[API::Groups::Group].optional.default(nil)

#profile ⇒ API::Users::UserMin

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:

• (API::Users::UserMin) —

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

# File 'lib/vk/api/search/hint.rb', line 21

attribute :profile, Dry::Types[API::Users::UserMin].optional.default(nil)

#section ⇒ String

Returns Section title.

Returns:

• (String) —

  Section title

# File 'lib/vk/api/search/hint.rb', line 13

attribute :section, API::Types::Coercible::String.enum("groups", "events", "publics", "correspondents", "people", "friends", "mutual_friends")

#type ⇒ String

Returns Object type.

Returns:

• (String) —

  Object type

# File 'lib/vk/api/search/hint.rb', line 11

attribute :type, API::Types::Coercible::String.enum("group", "profile")