Class: SchemaOrg::ItemList

Inherits:
Base
  • Object
show all
Includes:
Mixins::ItemList, _ItemList
Defined in:
lib/schema_org/types/item_list.rb,
sig/schema_org.rbs

Overview

https://schema.org/ItemList

A list of items of any sort—for example, Top 10 Movies About Weathermen, or Top 100 Party Songs. Not to be confused with HTML lists, which are often used only for formatting.

Constant Summary collapse

SCHEMA_NAME =
"ItemList"
SCHEMA_TYPES =
[self, SchemaOrg::Intangible, SchemaOrg::Thing].freeze

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Mixins::ItemList

#aggregate_element, #aggregate_element=, #item_list_element, #item_list_element=, #item_list_order, #item_list_order=, #number_of_items, #number_of_items=, schema_property_definitions

Methods included from Mixins::Intangible

schema_property_definitions

Methods included from Mixins::Thing

#additional_type, #additional_type=, #alternate_name, #alternate_name=, #description, #description=, #disambiguating_description, #disambiguating_description=, #identifier, #identifier=, #image, #image=, #main_entity_of_page, #main_entity_of_page=, #name, #name=, #owner, #owner=, #potential_action, #potential_action=, #same_as, #same_as=, schema_property_definitions, #subject_of, #subject_of=, #url, #url=

Methods included from _ItemList

#additional_type, #additional_type=, #aggregate_element, #aggregate_element=, #alternate_name, #alternate_name=, #description, #description=, #disambiguating_description, #disambiguating_description=, #identifier, #identifier=, #image, #image=, #item_list_element, #item_list_element=, #item_list_order, #item_list_order=, #main_entity_of_page, #main_entity_of_page=, #name, #name=, #number_of_items, #number_of_items=, #owner, #owner=, #potential_action, #potential_action=, #same_as, #same_as=, #subject_of, #subject_of=, #url, #url=

Class Method Details

.new(**properties) ⇒ ItemList

Parameters:

Returns:



30
31
32
# File 'lib/schema_org/types/item_list.rb', line 30

def new(**properties)
  super
end

.schema_nameString

Returns:

  • (String)


17
18
19
# File 'lib/schema_org/types/item_list.rb', line 17

def schema_name
  SCHEMA_NAME
end

.schema_type?(other_type) ⇒ Boolean

Parameters:

  • (Object)

Returns:



25
26
27
28
# File 'lib/schema_org/types/item_list.rb', line 25

def schema_type?(other_type)
  Base.schema_type_argument!(other_type)
  SCHEMA_TYPES.include?(other_type)
end

.schema_types::Array[::Class]

Returns:

  • (::Array[::Class])


21
22
23
# File 'lib/schema_org/types/item_list.rb', line 21

def schema_types
  SCHEMA_TYPES
end

Instance Method Details

#schema_type?Boolean

Parameters:

  • (Object)

Returns:



63346
# File 'sig/schema_org.rbs', line 63346

def schema_type?: (untyped) -> bool

#schema_types::Array[::Class]

Returns:

  • (::Array[::Class])


63345
# File 'sig/schema_org.rbs', line 63345

def schema_types: () -> ::Array[::Class]