Class: SchemaOrg::OrderStatus

Inherits:
Base
  • Object
show all
Includes:
Mixins::OrderStatus, _OrderStatus
Defined in:
lib/schema_org/types/order_status.rb,
sig/schema_org.rbs

Overview

https://schema.org/OrderStatus

Enumerated status values for Order.

Constant Summary collapse

SCHEMA_NAME =
"OrderStatus"
SCHEMA_TYPES =
[self, SchemaOrg::StatusEnumeration, SchemaOrg::Enumeration, SchemaOrg::Intangible, SchemaOrg::Thing].freeze
ORDER_CANCELLED =

Returns:

EnumerationValue.new("OrderCancelled", [SchemaOrg::OrderStatus])
ORDER_DELIVERED =

Returns:

EnumerationValue.new("OrderDelivered", [SchemaOrg::OrderStatus])
ORDER_IN_TRANSIT =

Returns:

EnumerationValue.new("OrderInTransit", [SchemaOrg::OrderStatus])
ORDER_PAYMENT_DUE =

Returns:

EnumerationValue.new("OrderPaymentDue", [SchemaOrg::OrderStatus])
ORDER_PICKUP_AVAILABLE =

Returns:

EnumerationValue.new("OrderPickupAvailable", [SchemaOrg::OrderStatus])
ORDER_PROBLEM =

Returns:

EnumerationValue.new("OrderProblem", [SchemaOrg::OrderStatus])
ORDER_PROCESSING =

Returns:

EnumerationValue.new("OrderProcessing", [SchemaOrg::OrderStatus])
ORDER_RETURNED =

Returns:

EnumerationValue.new("OrderReturned", [SchemaOrg::OrderStatus])
VALUES =
[ORDER_CANCELLED, ORDER_DELIVERED, ORDER_IN_TRANSIT, ORDER_PAYMENT_DUE, ORDER_PICKUP_AVAILABLE, ORDER_PROBLEM, ORDER_PROCESSING, ORDER_RETURNED].freeze

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Mixins::OrderStatus

schema_property_definitions

Methods included from Mixins::StatusEnumeration

schema_property_definitions

Methods included from Mixins::Enumeration

schema_property_definitions, #superseded_by, #superseded_by=

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 _OrderStatus

#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=, #subject_of, #subject_of=, #superseded_by, #superseded_by=, #url, #url=

Class Method Details

.new(**properties) ⇒ OrderStatus

Parameters:

Returns:



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

def new(**properties)
  super
end

.schema_nameString

Returns:

  • (String)


17
18
19
# File 'lib/schema_org/types/order_status.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/order_status.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/order_status.rb', line 21

def schema_types
  SCHEMA_TYPES
end

.values::Array[SchemaOrg::EnumerationValue[SchemaOrg::_OrderStatus]]

Returns:



44
45
46
# File 'lib/schema_org/types/order_status.rb', line 44

def self.values
  VALUES
end

Instance Method Details

#schema_type?Boolean

Parameters:

  • (Object)

Returns:



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

def schema_type?: (untyped) -> bool

#schema_types::Array[::Class]

Returns:

  • (::Array[::Class])


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

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