Class: Discorb::Gateway::TypingStartEvent

Inherits:

GatewayEvent

Object
GatewayEvent
Discorb::Gateway::TypingStartEvent

show all

Defined in:: lib/discorb/gateway_events.rb

Overview

Represents a TYPING_START event.

Instance Attribute Summary collapse

#channel -> nil, Discorb::Channel readonly
#guild -> nil, Discorb::Guild readonly
#user -> nil, ... (also: #member) readonly
#user_id -> Discorb::Snowflake readonly

The ID of the channel the user is typing in.

Method Summary

Methods inherited from GatewayEvent

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_events.rb', line 469

#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_events.rb', line 469

#user -> `nil`, ... (readonly) Also known as: member

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, Discorb::Member) —

The user that is typing.

# File 'lib/discorb/gateway_events.rb', line 469

#user_id -> `Discorb::Snowflake` (readonly)

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

Returns:

(Discorb::Snowflake) —

The ID of the channel the user is typing in.



467
468
469

# File 'lib/discorb/gateway_events.rb', line 467

def user_id
  @user_id
end