Class: Discorb::Gateway::TypingStartEvent

Inherits:
GatewayEvent show all
Defined in:
lib/discorb/gateway.rb

Overview

Represents a TYPING_START event.

Instance Attribute Summary collapse

Instance Attribute Details

#channel -> nil, Discorb::Channel (readonly)

Note:

This method returns an object from client cache. it will return nil if the object is not in cache.

Returns:

  • (nil) —

    The object wasn't cached.

  • (Discorb::Channel) —

    The channel the user is typing in.




# File 'lib/discorb/gateway.rb', line 389

#fired_by -> nil, ... (readonly) Also known as: from

Note:

This method returns an object from client cache. it will return nil if the object is not in cache.

Returns:




# File 'lib/discorb/gateway.rb', line 389

#guild -> nil, Discorb::Guild (readonly)

Note:

This method returns an object from client cache. it will return nil if the object is not in cache.

Returns:

  • (nil) —

    The object wasn't cached.

  • (Discorb::Guild) —

    The guild the user is typing in.




# File 'lib/discorb/gateway.rb', line 389

#member -> nil, Discorb::Member (readonly)

Note:

This method returns an object from client cache. it will return nil if the object is not in cache.

Returns:

  • (nil) —

    The object wasn't cached.

  • (Discorb::Member) —

    The member that is typing.



387
388
389
 
# File 'lib/discorb/gateway.rb', line 387

def member
  @member
end

#user -> nil, Discorb::User (readonly)

Note:

This method returns an object from client cache. it will return nil if the object is not in cache.

Returns:

  • (nil) —

    The object wasn't cached.

  • (Discorb::User) —

    The user that is typing.




# File 'lib/discorb/gateway.rb', line 389

#user_id -> Discorb::Snowflake (readonly)

Returns The ID of the channel the user is typing in.

Returns:



384
385
386
 
# File 'lib/discorb/gateway.rb', line 384

def user_id
  @user_id
end