Class: SchemaOrg::AggregateRating

Inherits:

Base

• Object
• Base
• SchemaOrg::AggregateRating

Includes:

Mixins::AggregateRating, _AggregateRating

Defined in:

lib/schema_org/types/aggregate_rating.rb,
sig/schema_org.rbs

Overview

https://schema.org/AggregateRating

The average rating based on multiple ratings or reviews.

Constant Summary

SCHEMA_NAME =

"AggregateRating"

SCHEMA_TYPES =

[self, SchemaOrg::Rating, SchemaOrg::Intangible, SchemaOrg::Thing].freeze

Class Method Summary

• .new(**properties) ⇒ AggregateRating
• .schema_name ⇒ String
• .schema_type?(other_type) ⇒ Boolean
• .schema_types ⇒ ::Array[::Class]

Instance Method Summary

• #schema_type? ⇒ Boolean
• #schema_types ⇒ ::Array[::Class]

Methods included from Mixins::AggregateRating

#item_reviewed, #item_reviewed=, #rating_count, #rating_count=, #review_count, #review_count=, schema_property_definitions

Methods included from Mixins::Rating

#author, #author=, #best_rating, #best_rating=, #rating_explanation, #rating_explanation=, #rating_value, #rating_value=, #review_aspect, #review_aspect=, schema_property_definitions, #worst_rating, #worst_rating=

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 _AggregateRating

#additional_type, #additional_type=, #alternate_name, #alternate_name=, #author, #author=, #best_rating, #best_rating=, #description, #description=, #disambiguating_description, #disambiguating_description=, #identifier, #identifier=, #image, #image=, #item_reviewed, #item_reviewed=, #main_entity_of_page, #main_entity_of_page=, #name, #name=, #owner, #owner=, #potential_action, #potential_action=, #rating_count, #rating_count=, #rating_explanation, #rating_explanation=, #rating_value, #rating_value=, #review_aspect, #review_aspect=, #review_count, #review_count=, #same_as, #same_as=, #subject_of, #subject_of=, #url, #url=, #worst_rating, #worst_rating=

Class Method Details

.new(**properties) ⇒ AggregateRating

Parameters:

• additional_type: (String, ::Array[String], nil)
• alternate_name: (String, ::Array[String], nil)
• author: (SchemaOrg::_Organization, SchemaOrg::_Person, ::Array[SchemaOrg::_Organization | SchemaOrg::_Person], nil)
• best_rating: (Numeric, String, ::Array[Numeric | String], nil)
• description: (String, SchemaOrg::_TextObject, ::Array[String | SchemaOrg::_TextObject], nil)
• disambiguating_description: (String, ::Array[String], nil)
• identifier: (SchemaOrg::_PropertyValue, String, ::Array[SchemaOrg::_PropertyValue | String], nil)
• image: (SchemaOrg::_ImageObject, String, ::Array[SchemaOrg::_ImageObject | String], nil)
• item_reviewed: (SchemaOrg::_Thing, ::Array[SchemaOrg::_Thing], nil)
• main_entity_of_page: (SchemaOrg::_CreativeWork, String, ::Array[SchemaOrg::_CreativeWork | String], nil)
• name: (String, ::Array[String], nil)
• owner: (SchemaOrg::_Organization, SchemaOrg::_Person, ::Array[SchemaOrg::_Organization | SchemaOrg::_Person], nil)
• potential_action: (SchemaOrg::_Action, ::Array[SchemaOrg::_Action], nil)
• rating_count: (Integer, ::Array[Integer], nil)
• rating_explanation: (String, ::Array[String], nil)
• rating_value: (Numeric, String, ::Array[Numeric | String], nil)
• review_aspect: (SchemaOrg::_StructuredValue, String, ::Array[SchemaOrg::_StructuredValue | String], nil)
• review_count: (Integer, ::Array[Integer], nil)
• same_as: (String, ::Array[String], nil)
• subject_of: (SchemaOrg::_CreativeWork, SchemaOrg::_Event, ::Array[SchemaOrg::_CreativeWork | SchemaOrg::_Event], nil)
• url: (String, ::Array[String], nil)
• worst_rating: (Numeric, String, ::Array[Numeric | String], nil)

Returns:

• (AggregateRating)

# File 'lib/schema_org/types/aggregate_rating.rb', line 30

def new(**properties)
  super
end

.schema_name ⇒ String

Returns:

• (String)

# File 'lib/schema_org/types/aggregate_rating.rb', line 17

def schema_name
  SCHEMA_NAME
end

.schema_type?(other_type) ⇒ Boolean

Parameters:

• (Object)

Returns:

• (Boolean)

# File 'lib/schema_org/types/aggregate_rating.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])

# File 'lib/schema_org/types/aggregate_rating.rb', line 21

def schema_types
  SCHEMA_TYPES
end

Instance Method Details

#schema_type? ⇒ Boolean

Parameters:

• (Object)

Returns:

• (Boolean)

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

def schema_type?: (untyped) -> bool

#schema_types ⇒ ::Array[::Class]

Returns:

• (::Array[::Class])

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

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