TransitObject
import type { TransitObject } from "https://googleapis.deno.dev/v1/walletobjects:v1.ts";
§Properties
The activation status for the object. Required if the class has
activationOptions
set.
Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
The concession category for the ticket.
A custom concession category to use when concessionCategory
does not
provide the right option. Both concessionCategory
and
customConcessionCategory
may not be set.
A custom status to use for the ticket status value when ticketStatus
does not provide the right option. Both ticketStatus
and
customTicketStatus
may not be set.
Device context associated with the object.
Indicates if notifications should explicitly be suppressed. If this field
is set to true, regardless of the messages
field, expiration
notifications to the user will be suppressed. By default, this field is set
to false. Currently, this can only be set for offers.
Information that controls how passes are grouped together.
Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
The background color for the card. If not set the dominant color of the
hero image is used, and if no hero image is set, the dominant color of the
logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such
as #ffcc00
. You can also use the shorthand version of the RGB triplet
which is #rgb, such as #fc0
.
Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
Deprecated. Use textModulesData instead.
Links module data. If links module data is also defined on the class, both will be displayed.
Note: This field is currently not supported to trigger geo notifications.
Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
The name(s) of the passengers the ticket is assigned to. The above
passengerType
field is meant to give Google context on this field.
The number of passengers.
Purchase details for this ticket.
The rotating barcode type and value.
The value that will be transmitted to a Smart Tap certified terminal over
NFC for this object. The class level fields enableSmartTap
and
redemptionIssuers
must also be set up correctly in order for the pass to
support Smart Tap. Only ASCII characters are supported.
Required. The state of the object. This field is used to determine how an
object is displayed in the app. For example, an inactive
object is moved
to the "Expired passes" section.
Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
The number of the ticket. This is a unique identifier for the ticket in the transit operator's system.
Information about what kind of restrictions there are on using this ticket. For example, which days of the week it must be used, or which routes are allowed to be taken.
The status of the ticket. For states which affect display, use the state
field instead.
This id is used to group tickets together if the user has saved multiple tickets for the same trip.
Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination.
The time period this object will be active
and object can be used. An
object's state will be changed to expired
when this time period has
passed.