Class: Vk::API::Groups::Methods::EditManager

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

Overview

Allows to add, remove or edit the community manager .

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :group_id (Integer)

    Community ID.

  • :user_id (Integer)

    User ID.

  • :role (String)

    Manager role. Possible values:; *'moderator';; *'editor';; *'administrator'.

  • :is_contact (Boolean)

    '1' — to show the manager in Contacts block of the community.

  • :contact_position (String)

    Position to show in Contacts block.

  • :contact_phone (String)

    Contact phone.

  • :contact_email (String)

    Contact e-mail.


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

Instance Method Details

#contact_emailString

Returns Contact e-mail.

Returns:

  • (String)

    Contact e-mail.


41
# File 'lib/vk/api/groups/methods/edit_manager.rb', line 41

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

#contact_phoneString

Returns Contact phone.

Returns:

  • (String)

    Contact phone.


39
# File 'lib/vk/api/groups/methods/edit_manager.rb', line 39

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

#contact_positionString

Returns Position to show in Contacts block.

Returns:

  • (String)

    Position to show in Contacts block.


37
# File 'lib/vk/api/groups/methods/edit_manager.rb', line 37

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

#group_idInteger

Returns Community ID.

Returns:

  • (Integer)

    Community ID.


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

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

#is_contactBoolean

Returns '1' — to show the manager in Contacts block of the community.

Returns:

  • (Boolean)

    '1' — to show the manager in Contacts block of the community.


35
# File 'lib/vk/api/groups/methods/edit_manager.rb', line 35

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

#roleString

Returns Manager role. Possible values:; *'moderator';; *'editor';; *'administrator'.

Returns:

  • (String)

    Manager role. Possible values:; *'moderator';; *'editor';; *'administrator'.


33
# File 'lib/vk/api/groups/methods/edit_manager.rb', line 33

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

#user_idInteger

Returns User ID.

Returns:

  • (Integer)

    User ID.


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

attribute :user_id, API::Types::Coercible::Int