Class: XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community

Defined in:

lib/x_twitter_scraper/models/x/community_retrieve_info_response.rb,
sig/x_twitter_scraper/models/x/community_retrieve_info_response.rbs

Overview

See Also:

• XTwitterScraper::Models::X::CommunityRetrieveInfoResponse#community

Defined Under Namespace

Classes: Creator, PrimaryTopic, Rule

Instance Attribute Summary

• #banner_url ⇒ String^?

  Community banner image URL.

• #created_at ⇒ String^?

  Community creation timestamp.

• #creator ⇒ XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::Creator^?
• #description ⇒ String^?

  About text for the community.

• #id ⇒ String

  Unique community identifier.

• #invites_policy ⇒ String^?

  Invitation policy.

• #is_member ⇒ Boolean^?

  Whether the authenticated viewer is a member.

• #is_nsfw ⇒ Boolean^?

  Whether the community is marked sensitive.

• #join_policy ⇒ String^?

  Join policy (open or restricted).

• #member_count ⇒ Integer^?

  Total member count.

• #moderator_count ⇒ Integer^?

  Total moderator count.

• #name ⇒ String^?

  Display name of the community.

• #primary_topic ⇒ XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::PrimaryTopic^?

  Primary topic.

• #role ⇒ String^?

  Authenticated viewer's community role.

• #rules ⇒ Array<XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::Rule>^?

  Community rules.

Instance Method Summary

• #initialize(id: nil, name: nil) ⇒ Object constructor

  Primary topic.

• #to_hash ⇒ {

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: nil, name: nil) ⇒ Object

Primary topic

Parameters:

• id (String) (defaults to: nil)
• name (String) (defaults to: nil)

# File 'lib/x_twitter_scraper/models/x/community_retrieve_info_response.rb', line 114

Instance Attribute Details

#banner_url ⇒ String^?

Community banner image URL

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/community_retrieve_info_response.rb', line 33

optional :banner_url, String

#created_at ⇒ String^?

Community creation timestamp

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/community_retrieve_info_response.rb', line 39

optional :created_at, String

#creator ⇒ XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::Creator^?

Returns:

• (XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::Creator, nil)

# File 'lib/x_twitter_scraper/models/x/community_retrieve_info_response.rb', line 44

optional :creator, -> { XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::Creator }

#description ⇒ String^?

About text for the community

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/community_retrieve_info_response.rb', line 50

optional :description, String

#id ⇒ String

Unique community identifier

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/x_twitter_scraper/models/x/community_retrieve_info_response.rb', line 27

required :id, String

#invites_policy ⇒ String^?

Invitation policy

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/community_retrieve_info_response.rb', line 56

optional :invites_policy, String

#is_member ⇒ Boolean^?

Whether the authenticated viewer is a member

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/x/community_retrieve_info_response.rb', line 62

optional :is_member, XTwitterScraper::Internal::Type::Boolean

#is_nsfw ⇒ Boolean^?

Whether the community is marked sensitive

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/x/community_retrieve_info_response.rb', line 68

optional :is_nsfw, XTwitterScraper::Internal::Type::Boolean

#join_policy ⇒ String^?

Join policy (open or restricted)

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/community_retrieve_info_response.rb', line 74

optional :join_policy, String

#member_count ⇒ Integer^?

Total member count

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/x/community_retrieve_info_response.rb', line 80

optional :member_count, Integer

#moderator_count ⇒ Integer^?

Total moderator count

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/x/community_retrieve_info_response.rb', line 86

optional :moderator_count, Integer

#name ⇒ String^?

Display name of the community

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/community_retrieve_info_response.rb', line 92

optional :name, String

#primary_topic ⇒ XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::PrimaryTopic^?

Primary topic

Returns:

• (XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::PrimaryTopic, nil)

# File 'lib/x_twitter_scraper/models/x/community_retrieve_info_response.rb', line 98

optional :primary_topic,
-> { XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::PrimaryTopic }

#role ⇒ String^?

Authenticated viewer's community role

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/community_retrieve_info_response.rb', line 105

optional :role, String

#rules ⇒ Array<XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::Rule>^?

Community rules

Returns:

• (Array<XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::Rule>, nil)

# File 'lib/x_twitter_scraper/models/x/community_retrieve_info_response.rb', line 111

optional :rules,
-> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::Rule] }

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/x_twitter_scraper/models/x/community_retrieve_info_response.rbs', line 126

def to_hash: -> {