API Docs for: 1.3.12
Show:

OfferCatalog Class

Schema.org/OfferCatalog An OfferCatalog is an ItemList that contains related Offers and/or further OfferCatalogs that are offeredBy the same provider.

Methods

getDescription

() String

Returns the description of the thing

Returns:

String:

description of Thing

getName

() String

Returns the name of the thing

Returns:

String:

name of Thing

setDescription

(
  • description
)

Method to set Thing description

Parameters:

  • description String

    Description to set for its Thing

setName

(
  • name
)

Method to set Thing name

Parameters:

  • name String

    Name to set for this Thing

Properties

additionalType

URL

Schema.org/additionalType An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.

alternateName

Text

Schema.org/alternateName An alias for the item.

description

Text

Schema.org/description A description of the item.

disambiguatingDescription

Text

Schema.org/disambiguatingDescription A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.

identifier

Schema, URL | schema,Text | schema,PropertyValue

Schema.org/identifier The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.

image

Schema, URL | schema,ImageObject

Schema.org/image An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].

itemListElement

ListItem

Schema.org/itemListElement For itemListElement values, you can use simple strings (e.g. "Peter", "Paul", "Mary"), existing entities, or use ListItem.\n\nText values are best if the elements in the list are plain strings. Existing entities are best for a simple, unordered list of existing things in your data. ListItem is used with ordered lists when you want to provide additional context about the element in that list or when the same item might be in different places in different lists.\n\nNote: The order of elements in your mark-up is not sufficient for indicating the order or elements. Use ListItem with a 'position' property in such cases.

itemListOrder

Text

Schema.org/itemListOrder Type of ordering (e.g. Ascending, Descending, Unordered).

mainEntityOfPage

Schema, URL | schema,CreativeWork

Schema.org/mainEntityOfPage Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.

name

Text

Schema.org/name The name of the item.

numberOfItems

Integer

Schema.org/numberOfItems The number of items in an ItemList. Note that some descriptions might not fully describe all items in a list (e.g., multi-page pagination); in such cases, the numberOfItems would be for the entire list.

potentialAction

Action

Schema.org/potentialAction Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.

sameAs

URL

Schema.org/sameAs URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.

url

URL

Schema.org/url URL of the item.