Class: XTwitterScraper::Models::Event

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/x_twitter_scraper/models/event.rb,
sig/x_twitter_scraper/models/event.rbs

Defined Under Namespace

Modules: MonitorType

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, data:, monitor_id:, monitor_type:, occurred_at:, type:, keyword_monitor_id: nil, query: nil, username: nil) ⇒ Object

Some parameter documentations has been truncated, see XTwitterScraper::Models::Event for more details.

Monitor event summary with source metadata and occurrence time.

Parameters:

  • id (String)
  • data (Hash{Symbol=>Object})
  • monitor_id (String) —

    Account monitor ID for account events, or keyword monitor ID for keyword events.

  • monitor_type (Symbol, XTwitterScraper::Models::Event::MonitorType) —

    Source monitor type.

  • occurred_at (Time)
  • type (Symbol, XTwitterScraper::Models::EventType) —

    Type of monitor event fired when account activity occurs.

  • keyword_monitor_id (String) (defaults to: nil) —

    Keyword monitor ID, present for keyword monitor events.

  • query (String) (defaults to: nil) —

    Keyword query, present for keyword monitor events.

  • username (String) (defaults to: nil) —

    Account username, present for account monitor events.




# File 'lib/x_twitter_scraper/models/event.rb', line 57

Instance Attribute Details

#data ⇒ Hash{Symbol=>Object}

Parameters:

  • value (::Hash[Symbol, top])

Returns:

  • (Hash{Symbol=>Object}) 


14
 
# File 'lib/x_twitter_scraper/models/event.rb', line 14

required :data, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


9
 
# File 'lib/x_twitter_scraper/models/event.rb', line 9

required :id, String

#keyword_monitor_id ⇒ String?

Keyword monitor ID, present for keyword monitor events.

Parameters:

  • (String)

Returns:

  • (String, nil) 


43
 
# File 'lib/x_twitter_scraper/models/event.rb', line 43

optional :keyword_monitor_id, String, api_name: :keywordMonitorId

#monitor_id ⇒ String

Account monitor ID for account events, or keyword monitor ID for keyword events.

Parameters:

  • value (String)

Returns:

  • (String) 


20
 
# File 'lib/x_twitter_scraper/models/event.rb', line 20

required :monitor_id, String, api_name: :monitorId

#monitor_type ⇒ Symbol, XTwitterScraper::Models::Event::MonitorType

Source monitor type.

Parameters:

  • value (XTwitterScraper::Models::Event::monitor_type)

Returns:



26
 
# File 'lib/x_twitter_scraper/models/event.rb', line 26

required :monitor_type, enum: -> { XTwitterScraper::Event::MonitorType }, api_name: :monitorType

#occurred_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


31
 
# File 'lib/x_twitter_scraper/models/event.rb', line 31

required :occurred_at, Time, api_name: :occurredAt

#query ⇒ String?

Keyword query, present for keyword monitor events.

Parameters:

  • (String)

Returns:

  • (String, nil) 


49
 
# File 'lib/x_twitter_scraper/models/event.rb', line 49

optional :query, String

#type ⇒ Symbol, XTwitterScraper::Models::EventType

Type of monitor event fired when account activity occurs.

Parameters:

  • value (XTwitterScraper::Models::event_type)

Returns:



37
 
# File 'lib/x_twitter_scraper/models/event.rb', line 37

required :type, enum: -> { XTwitterScraper::EventType }

#username ⇒ String?

Account username, present for account monitor events.

Parameters:

  • (String)

Returns:

  • (String, nil) 


55
 
# File 'lib/x_twitter_scraper/models/event.rb', line 55

optional :username, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


53
 
# File 'sig/x_twitter_scraper/models/event.rbs', line 53

def to_hash: -> {