Semantics class

https://developer.apple.com/documentation/walletpasses/pass/supporting_semantic_tags_in_wallet_passes

Annotations
  • @JsonSerializable(includeIfNull: false)

Constructors

Semantics({String? airlineCode, List<String>? artistIDs, String? awayTeamAbbreviation, String? awayTeamLocation, String? awayTeamName, String? boardingGroup, String? boardingSequenceNumber, String? carNumber, String? confirmationNumber, DateTime? currentArrivalDate, DateTime? currentBoardingDate, DateTime? currentDepartureDate, String? departureAirportCode, String? departureAirportName, String? departureGate, String? departureLocationDescription, String? departurePlatform, String? departureStationName, String? departureTerminal, String? destinationAirportCode, String? destinationAirportName, String? destinationGate, String? destinationLocationDescription, String? destinationPlatform, String? destinationStationName, String? destinationTerminal, num? duration, DateTime? eventEndDate, String? eventName, DateTime? eventStartDate, EventType? eventType, String? flightCode, num? flightNumber, String? genre, String? homeTeamAbbreviation, String? homeTeamLocation, String? homeTeamName, String? leagueAbbreviation, String? leagueName, String? membershipProgramName, String? membershipProgramNumber, DateTime? originalArrivalDate, DateTime? originalBoardingDate, DateTime? originalDepartureDate, List<String>? performerNames, String? priorityStatus, String? securityScreening, bool? silenceRequested, String? sportName, String? transitProvider, String? transitStatus, String? transitStatusReason, String? vehicleName, String? vehicleNumber, String? vehicleType, String? venueEntrance, String? venueName, String? venuePhoneNumber, String? venueRoom, SemanticTagTypeCurrencyAmount? balance, SemanticTagTypeLocation? departureLocation, SemanticTagTypeLocation? destinationLocation, List<SemanticTagTypeSeat>? seats, SemanticTagTypeCurrencyAmount? totalPrice, SemanticTagTypeLocation? venueLocation, List<SemanticTagTypeWifiNetwork>? wifiAccess, SemanticTagTypePersonNameComponents? passengerName})
Semantics.fromJson(Map<String, dynamic> json)
factory

Properties

airlineCode → String?
The IATA airline code, such as “EX” for flightCode “EX123”. Use this key only for airline boarding passes.
final
artistIDs → List<String>?
An array of the Apple Music persistent ID for each artist performing at the event, in decreasing order of significance. Use this key for any type of event ticket.
final
awayTeamAbbreviation → String?
The unique abbreviation of the away team’s name. Use this key only for a sports event ticket.
final
awayTeamLocation → String?
The home location of the away team. Use this key only for a sports event ticket.
final
awayTeamName → String?
The name of the away team. Use this key only for a sports event ticket.
final
balance → SemanticTagTypeCurrencyAmount?
The current balance redeemable with the pass. Use this key only for a store card pass.
final
boardingGroup → String?
A group number for boarding. Use this key for any type of boarding pass.
final
boardingSequenceNumber → String?
A sequence number for boarding. Use this key for any type of boarding pass.
final
carNumber → String?
The number of the passenger car. A train car is also called a carriage, wagon, coach, or bogie in some countries. Use this key only for a train or other rail boarding pass.
final
confirmationNumber → String?
A booking or reservation confirmation number. Use this key for any type of boarding pass.
final
currentArrivalDate → DateTime?
The updated date and time of arrival, if different from the originally scheduled date and time. Use this key for any type of boarding pass.
final
currentBoardingDate → DateTime?
The updated date and time of boarding, if different from the originally scheduled date and time. Use this key for any type of boarding pass.
final
currentDepartureDate → DateTime?
The updated departure date and time, if different from the originally scheduled date and time. Use this key for any type of boarding pass.
final
departureAirportCode → String?
The IATA airport code for the departure airport, such as “MPM” or “LHR”. Use this key only for airline boarding passes.
final
departureAirportName → String?
The full name of the departure airport, such as “Maputo International Airport”. Use this key only for airline boarding passes.
final
departureGate → String?
The gate number or letters of the departure gate, such as “1A”. Do not include the word “Gate.”
final
departureLocation → SemanticTagTypeLocation?
An object that represents the geographic coordinates of the transit departure location, suitable for display on a map. If possible, use precise locations, which are more useful to travelers; for example, the specific location of an airport gate. Use this key for any type of boarding pass.
final
departureLocationDescription → String?
A brief description of the departure location. For example, for a flight departing from an airport whose code is “LHR,” an appropriate description might be “London, Heathrow“. Use this key for any type of boarding pass.
final
departurePlatform → String?
The name of the departure platform, such as “A”. Don’t include the word “Platform.” Use this key only for a train or other rail boarding pass.
final
departureStationName → String?
The name of the departure station, such as “1st Street Station”. Use this key only for a train or other rail boarding pass.
final
departureTerminal → String?
The name or letter of the departure terminal, such as “A”. Don’t include the word “Terminal.” Use this key only for airline boarding passes.
final
destinationAirportCode → String?
The IATA airport code for the destination airport, such as “MPM” or “LHR”. Use this key only for airline boarding passes.
final
destinationAirportName → String?
The full name of the destination airport, such as “London Heathrow”. Use this key only for airline boarding passes.
final
destinationGate → String?
The gate number or letter of the destination gate, such as “1A”. Don’t include the word “Gate.” Use this key only for airline boarding passes.
final
destinationLocation → SemanticTagTypeLocation?
An object that represents the geographic coordinates of the transit departure location, suitable for display on a map. Use this key for any type of boarding pass.
final
destinationLocationDescription → String?
A brief description of the destination location. For example, for a flight arriving at an airport whose code is “MPM,” “Maputo“ might be an appropriate description. Use this key for any type of boarding pass.
final
destinationPlatform → String?
The name of the destination platform, such as “A”. Don’t include the word “Platform.” Use this key only for a train or other rail boarding pass.
final
destinationStationName → String?
The name of the destination station, such as “1st Street Station”. Use this key only for a train or other rail boarding pass.
final
destinationTerminal → String?
The terminal name or letter of the destination terminal, such as “A”. Don’t include the word “Terminal.” Use this key only for airline boarding passes.
final
duration → num?
The duration of the event or transit journey, in seconds. Use this key for any type of boarding pass and any type of event ticket.
final
eventEndDate → DateTime?
The date and time the event ends. Use this key for any type of event ticket.
final
eventName → String?
The full name of the event, such as the title of a movie. Use this key for any type of event ticket.
final
eventStartDate → DateTime?
The date and time the event starts. Use this key for any type of event ticket.
final
eventType → EventType?
The type of event. Use this key for any type of event ticket. Possible Values: PKEventTypeGeneric, PKEventTypeLivePerformance, PKEventTypeMovie, PKEventTypeSports, PKEventTypeConference, PKEventTypeConvention, PKEventTypeWorkshop, PKEventTypeSocialGathering
final
flightCode → String?
The IATA flight code, such as “EX123”. Use this key only for airline boarding passes.
final
flightNumber → num?
The numeric portion of the IATA flight code, such as 123 for flightCode “EX123”. Use this key only for airline boarding passes.
final
genre → String?
The genre of the performance, such as “Classical”. Use this key for any type of event ticket.
final
hashCode → int
The hash code for this object.
no setterinherited
homeTeamAbbreviation → String?
The unique abbreviation of the home team’s name. Use this key only for a sports event ticket.
final
homeTeamLocation → String?
The home location of the home team. Use this key only for a sports event ticket.
final
homeTeamName → String?
The name of the home team. Use this key only for a sports event ticket.
final
leagueAbbreviation → String?
The abbreviated league name for a sports event. Use this key only for a sports event ticket.
final
leagueName → String?
The unabbreviated league name for a sports event. Use this key only for a sports event ticket.
final
membershipProgramName → String?
The name of a frequent flyer or loyalty program. Use this key for any type of boarding pass.
final
membershipProgramNumber → String?
The ticketed passenger’s frequent flyer or loyalty number. Use this key for any type of boarding pass.
final
originalArrivalDate → DateTime?
The originally scheduled date and time of arrival. Use this key for any type of boarding pass.
final
originalBoardingDate → DateTime?
The originally scheduled date and time of boarding. Use this key for any type of boarding pass.
final
originalDepartureDate → DateTime?
The originally scheduled date and time of departure. Use this key for any type of boarding pass.
final
passengerName → SemanticTagTypePersonNameComponents?
An object that represents the name of the passenger. Use this key for any type of boarding pass.
final
performerNames → List<String>?
An array of the full names of the performers and opening acts at the event, in decreasing order of significance. Use this key for any type of event ticket.
final
priorityStatus → String?
The priority status the ticketed passenger holds, such as “Gold” or “Silver”. Use this key for any type of boarding pass.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
seats → List<SemanticTagTypeSeat>?
An array of objects that represent the details for each seat at an event or on a transit journey. Use this key for any type of boarding pass or event ticket.
final
securityScreening → String?
The type of security screening for the ticketed passenger, such as “Priority”. Use this key for any type of boarding pass.
final
silenceRequested → bool?
A Boolean value that determines whether the user’s device remains silent during an event or transit journey. The system may override the key and determine the length of the period of silence. Use this key for any type of boarding pass or event ticket.
final
sportName → String?
The commonly used name of the sport. Use this key only for a sports event ticket.
final
totalPrice → SemanticTagTypeCurrencyAmount?
The total price for the pass. Use this key for any pass type.
final
transitProvider → String?
The name of the transit company. Use this key for any type of boarding pass.
final
transitStatus → String?
A brief description of the current boarding status for the vessel, such as “On Time” or “Delayed”. For delayed status, provide currentBoardingDate, currentDepartureDate, and currentArrivalDate where available. Use this key for any type of boarding pass.
final
transitStatusReason → String?
A brief description that explains the reason for the current transitStatus, such as “Thunderstorms”. Use this key for any type of boarding pass.
final
vehicleName → String?
The name of the vehicle to board, such as the name of a boat. Use this key for any type of boarding pass.
final
vehicleNumber → String?
The identifier of the vehicle to board, such as the aircraft registration number or train number. Use this key for any type of boarding pass.
final
vehicleType → String?
A brief description of the type of vehicle to board, such as the model and manufacturer of a plane or the class of a boat. Use this key for any type of boarding pass.
final
venueEntrance → String?
The full name of the entrance, such as “Gate A”, to use to gain access to the ticketed event. Use this key for any type of event ticket.
final
venueLocation → SemanticTagTypeLocation?
An object that represents the geographic coordinates of the venue. Use this key for any type of event ticket.
final
venueName → String?
The full name of the venue. Use this key for any type of event ticket.
final
venuePhoneNumber → String?
The phone number for enquiries about the venue’s ticketed event. Use this key for any type of event ticket.
final
venueRoom → String?
The full name of the room where the ticketed event is to take place. Use this key for any type of event ticket.
final
wifiAccess → List<SemanticTagTypeWifiNetwork>?
An array of objects that represent the WiFi networks associated with the event; for example, the network name and password associated with a developer conference. Use this key for any type of pass.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited