Class: Vk::API::Pages::Methods::Get

Inherits:
Schema::Method show all
Defined in:
lib/vk/api/pages/methods/get.rb

Overview

Returns information about a wiki page.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Pages::Methods::Get

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :owner_id (Integer)

    Page owner ID.

  • :page_id (Integer)

    Wiki page ID.

  • :global (Boolean)

    '1' — to return information about a global wiki page

  • :site_preview (Boolean)

    '1' — resulting wiki page is a preview for the attached link

  • :title (String)

    Wiki page title.

  • :need_source (Boolean)
  • :need_html (Boolean)

    '1' — to return the page as HTML;


# File 'lib/vk/api/pages/methods/get.rb', line 15

Instance Method Details

#globalBoolean

Returns '1' — to return information about a global wiki page.

Returns:

  • (Boolean)

    '1' — to return information about a global wiki page


33
# File 'lib/vk/api/pages/methods/get.rb', line 33

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

#need_htmlBoolean

Returns '1' — to return the page as HTML;.

Returns:

  • (Boolean)

    '1' — to return the page as HTML;


41
# File 'lib/vk/api/pages/methods/get.rb', line 41

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

#need_sourceBoolean


39
# File 'lib/vk/api/pages/methods/get.rb', line 39

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

#owner_idInteger

Returns Page owner ID.

Returns:

  • (Integer)

    Page owner ID.


29
# File 'lib/vk/api/pages/methods/get.rb', line 29

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

#page_idInteger

Returns Wiki page ID.

Returns:

  • (Integer)

    Wiki page ID.


31
# File 'lib/vk/api/pages/methods/get.rb', line 31

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

#site_previewBoolean

Returns '1' — resulting wiki page is a preview for the attached link.

Returns:

  • (Boolean)

    '1' — resulting wiki page is a preview for the attached link


35
# File 'lib/vk/api/pages/methods/get.rb', line 35

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

#titleString

Returns Wiki page title.

Returns:

  • (String)

    Wiki page title.


37
# File 'lib/vk/api/pages/methods/get.rb', line 37

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