SchemaSchedule class
A schedule defines a repeating time period used to describe a regularly
occurring SchemaEvent. At a minimum a schedule will specify
SchemarepeatFrequency
which describes the interval between occurrences
of the event. Additional information can be provided to specify the
schedule more precisely. This includes identifying the day(s) of the week
or month when the recurring event will take place, in addition to its
start and end time. Schedules may also have start and end dates to
indicate when they are active, e.g. to define a limited calendar of
events.
See https://schema.org/Schedule
Constructors
- SchemaSchedule({dynamic byDay, int? byMonth, int? byMonthDay, int? byMonthWeek, SchemaDuration? duration, String? endDate, String? endTime, String? exceptDate, int? repeatCount, dynamic repeatFrequency, String? scheduleTimezone, String? startDate, String? startTime, String? additionalType, String? alternateName, dynamic description, String? disambiguatingDescription, dynamic identifier, dynamic image, dynamic mainEntityOfPage, String? name, SchemaAction? potentialAction, String? sameAs, dynamic subjectOf, String? url})
- Create a new instance of SchemaSchedule
Properties
- additionalType ↔ String?
-
//schema.org/docs/styleguide.html">style guide.
getter/setter pair
- alternateName ↔ String?
-
An alias for the item.
getter/setter pair
- byDay ↔ dynamic
-
Defines the day(s) of the week on which a recurring SchemaEvent takes
place. May be specified using either SchemaDayOfWeek, or alternatively
SchemaText
conforming to iCal's syntax for byDay recurrence rules.getter/setter pair - byMonth ↔ int?
-
Defines the month(s) of the year on which a recurring SchemaEvent takes
place. Specified as an
SchemaInteger
between 1-12. January is 1.getter/setter pair - byMonthDay ↔ int?
-
Defines the day(s) of the month on which a recurring SchemaEvent takes
place. Specified as an
SchemaInteger
between 1-31.getter/setter pair - byMonthWeek ↔ int?
-
Defines the week(s) of the month on which a recurring Event takes place.
Specified as an Integer between 1-5. For clarity, byMonthWeek is best
used in conjunction with byDay to indicate concepts like the first and
third Mondays of a month.
getter/setter pair
- description ↔ dynamic
-
A description of the item.
getter/setter pair
- disambiguatingDescription ↔ String?
-
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.
getter/setter pair
- duration ↔ SchemaDuration?
-
//en.wikipedia.org/wiki/ISO_8601).
getter/setter pair
- endDate ↔ String?
-
//en.wikipedia.org/wiki/ISO_8601)).
getter/setter pair
- endTime ↔ String?
-
The endTime of something. For a reserved event or service (e.g.
FoodEstablishmentReservation), the time that it is expected to end. For
actions that span a period of time, when the action was performed. E.g.
John wrote a book from January to December. For media, including audio
and video, it's the time offset of the end of a clip within a larger
file.\n\nNote that Event uses startDate/endDate instead of
startTime/endTime, even when describing dates with times. This situation
may be clarified in future revisions.
getter/setter pair
- exceptDate ↔ String?
-
Defines a
SchemaDate
orSchemaDateTime
during which a scheduled SchemaEvent will not take place. The property allows exceptions to a SchemaSchedule to be specified. If an exception is specified as aSchemaDateTime
then only the event that would have started at that specific date and time should be excluded from the schedule. If an exception is specified as aSchemaDate
then any event that is scheduled for that 24 hour period should be excluded from the schedule. This allows a whole day to be excluded from the schedule without having to itemise every scheduled event.getter/setter pair - hashCode → int
-
The hash code for this object.
no setterinherited
- identifier ↔ dynamic
-
The identifier property represents any kind of identifier for any kind of
SchemaThing, 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.
getter/setter pair
- image ↔ dynamic
-
An image of the item. This can be a
SchemaURL
or a fully described SchemaImageObject.getter/setter pair - mainEntityOfPage ↔ dynamic
-
Indicates a page (or other CreativeWork) for which this thing is the main
entity being described. See background
notes for details.
getter/setter pair
- name ↔ String?
-
The name of the item.
getter/setter pair
- potentialAction ↔ SchemaAction?
-
Indicates a potential Action, which describes an idealized action in
which this thing would play an 'object' role.
getter/setter pair
- repeatCount ↔ int?
-
Defines the number of times a recurring SchemaEvent will take place.
getter/setter pair
- repeatFrequency ↔ dynamic
-
Defines the frequency at which SchemaEvents will occur according to a
schedule SchemaSchedule. The intervals between events should be defined
as a SchemaDuration of time.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sameAs ↔ String?
-
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.
getter/setter pair
- scheduleTimezone ↔ String?
-
Indicates the timezone for which the time(s) indicated in the
SchemaSchedule are given. The value provided should be among those
listed in the IANA Time Zone Database.
getter/setter pair
- startDate ↔ String?
-
//en.wikipedia.org/wiki/ISO_8601)).
getter/setter pair
- startTime ↔ String?
-
The startTime of something. For a reserved event or service (e.g.
FoodEstablishmentReservation), the time that it is expected to start. For
actions that span a period of time, when the action was performed. E.g.
John wrote a book from January to December. For media, including audio
and video, it's the time offset of the start of a clip within a larger
file.\n\nNote that Event uses startDate/endDate instead of
startTime/endTime, even when describing dates with times. This situation
may be clarified in future revisions.
getter/setter pair
- subjectOf ↔ dynamic
-
A CreativeWork or Event about this Thing.
getter/setter pair
- url ↔ String?
-
URL of the item.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJsonLd(
) → Map< String, dynamic> - Serialize SchemaSchedule to JSON-LD
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited