Class: Vk::API::Friends::FriendStatus

Inherits:

Schema::Object

• Object
• Dry::Struct
• Schema::Object
• Vk::API::Friends::FriendStatus

Defined in:

lib/vk/api/friends/friend_status.rb

Overview

See Also:

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

Instance Method Summary

• #friend_status ⇒ Integer

  Friend status with the user.

• #read_state ⇒ Integer

  Information whether request is unviewed.

• #request_message ⇒ String

  Message sent with request.

• #sign ⇒ String

  MD5 hash for the result validation.

• #user_id ⇒ Integer

  User ID.

Instance Method Details

#friend_status ⇒ Integer

Returns Friend status with the user.

Returns:

• (Integer) —

  Friend status with the user

# File 'lib/vk/api/friends/friend_status.rb', line 13

attribute :friend_status, API::Types::Coercible::Int.enum(0, 1, 2, 3)

#read_state ⇒ Integer

Returns Information whether request is unviewed.

Returns:

• (Integer) —

  Information whether request is unviewed

# File 'lib/vk/api/friends/friend_status.rb', line 17

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

#request_message ⇒ String

Returns Message sent with request.

Returns:

• (String) —

  Message sent with request

# File 'lib/vk/api/friends/friend_status.rb', line 15

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

#sign ⇒ String

Returns MD5 hash for the result validation.

Returns:

• (String) —

  MD5 hash for the result validation

# File 'lib/vk/api/friends/friend_status.rb', line 19

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

#user_id ⇒ Integer

Returns User ID.

Returns:

• (Integer) —

  User ID

# File 'lib/vk/api/friends/friend_status.rb', line 11

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