View Source GoogleApi.WalletObjects.V1.Model.TransitObject (google_api_wallet_objects v0.2.0)
Attributes
-
messages
(type:list(GoogleApi.WalletObjects.V1.Model.Message.t)
, default:nil
) - An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10. -
passengerNames
(type:String.t
, default:nil
) - The name(s) of the passengers the ticket is assigned to. The abovepassengerType
field is meant to give Google context on this field. -
tripType
(type:String.t
, default:nil
) - 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. -
passengerType
(type:String.t
, default:nil
) - The number of passengers. -
passConstraints
(type:GoogleApi.WalletObjects.V1.Model.PassConstraints.t
, default:nil
) - Pass constraints for the object. Includes limiting NFC and screenshot behaviors. -
activationStatus
(type:GoogleApi.WalletObjects.V1.Model.ActivationStatus.t
, default:nil
) - The activation status for the object. Required if the class hasactivationOptions
set. -
tripId
(type:String.t
, default:nil
) - This id is used to group tickets together if the user has saved multiple tickets for the same trip. -
linksModuleData
(type:GoogleApi.WalletObjects.V1.Model.LinksModuleData.t
, default:nil
) - Links module data. If links module data is also defined on the class, both will be displayed. -
smartTapRedemptionValue
(type:String.t
, default:nil
) - The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fieldsenableSmartTap
andredemptionIssuers
must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. -
ticketStatus
(type:String.t
, default:nil
) - The status of the ticket. For states which affect display, use thestate
field instead. -
hasUsers
(type:boolean()
, default:nil
) - Indicates if the object has users. This field is set by the platform. -
state
(type:String.t
, default:nil
) - Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, aninactive
object is moved to the "Expired passes" section. -
hexBackgroundColor
(type:String.t
, default:nil
) - 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
. -
customTicketStatus
(type:GoogleApi.WalletObjects.V1.Model.LocalizedString.t
, default:nil
) - A custom status to use for the ticket status value whenticketStatus
does not provide the right option. BothticketStatus
andcustomTicketStatus
may not be set. -
ticketRestrictions
(type:GoogleApi.WalletObjects.V1.Model.TicketRestrictions.t
, default:nil
) - 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. -
classReference
(type:GoogleApi.WalletObjects.V1.Model.TransitClass.t
, default:nil
) - A copy of the inherited fields of the parent class. These fields are retrieved during a GET. -
version
(type:String.t
, default:nil
) - Deprecated -
classId
(type:String.t
, default:nil
) - 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. -
ticketLeg
(type:GoogleApi.WalletObjects.V1.Model.TicketLeg.t
, default:nil
) - A single ticket leg contains departure and arrival information along with boarding and seating information. If more than one leg is to be specified then use theticketLegs
field instead. BothticketLeg
andticketLegs
may not be set. -
hasLinkedDevice
(type:boolean()
, default:nil
) - 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. -
textModulesData
(type:list(GoogleApi.WalletObjects.V1.Model.TextModuleData.t)
, default:nil
) - 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. -
locations
(type:list(GoogleApi.WalletObjects.V1.Model.LatLongPoint.t)
, default:nil
) - Note: This field is currently not supported to trigger geo notifications. -
validTimeInterval
(type:GoogleApi.WalletObjects.V1.Model.TimeInterval.t
, default:nil
) - The time period this object will beactive
and object can be used. An object's state will be changed toexpired
when this time period has passed. -
infoModuleData
(type:GoogleApi.WalletObjects.V1.Model.InfoModuleData.t
, default:nil
) - Deprecated. Use textModulesData instead. -
heroImage
(type:GoogleApi.WalletObjects.V1.Model.Image.t
, default:nil
) - Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed. -
deviceContext
(type:GoogleApi.WalletObjects.V1.Model.DeviceContext.t
, default:nil
) - Device context associated with the object. -
id
(type:String.t
, default:nil
) - 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 '-'. -
imageModulesData
(type:list(GoogleApi.WalletObjects.V1.Model.ImageModuleData.t)
, default:nil
) - Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level. -
disableExpirationNotification
(type:boolean()
, default:nil
) - Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of themessages
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. -
concessionCategory
(type:String.t
, default:nil
) - The concession category for the ticket. -
customConcessionCategory
(type:GoogleApi.WalletObjects.V1.Model.LocalizedString.t
, default:nil
) - A custom concession category to use whenconcessionCategory
does not provide the right option. BothconcessionCategory
andcustomConcessionCategory
may not be set. -
groupingInfo
(type:GoogleApi.WalletObjects.V1.Model.GroupingInfo.t
, default:nil
) - Information that controls how passes are grouped together. -
appLinkData
(type:GoogleApi.WalletObjects.V1.Model.AppLinkData.t
, default:nil
) - Optional information about the partner app link. -
ticketNumber
(type:String.t
, default:nil
) - The number of the ticket. This is a unique identifier for the ticket in the transit operator's system. -
rotatingBarcode
(type:GoogleApi.WalletObjects.V1.Model.RotatingBarcode.t
, default:nil
) - The rotating barcode type and value. -
ticketLegs
(type:list(GoogleApi.WalletObjects.V1.Model.TicketLeg.t)
, default:nil
) - Each ticket may contain one or more legs. Each leg contains departure and arrival information along with boarding and seating information. If only one leg is to be specified then use theticketLeg
field instead. BothticketLeg
andticketLegs
may not be set. -
purchaseDetails
(type:GoogleApi.WalletObjects.V1.Model.PurchaseDetails.t
, default:nil
) - Purchase details for this ticket. -
barcode
(type:GoogleApi.WalletObjects.V1.Model.Barcode.t
, default:nil
) - The barcode type and value.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.WalletObjects.V1.Model.TransitObject{ activationStatus: GoogleApi.WalletObjects.V1.Model.ActivationStatus.t() | nil, appLinkData: GoogleApi.WalletObjects.V1.Model.AppLinkData.t() | nil, barcode: GoogleApi.WalletObjects.V1.Model.Barcode.t() | nil, classId: String.t() | nil, classReference: GoogleApi.WalletObjects.V1.Model.TransitClass.t() | nil, concessionCategory: String.t() | nil, customConcessionCategory: GoogleApi.WalletObjects.V1.Model.LocalizedString.t() | nil, customTicketStatus: GoogleApi.WalletObjects.V1.Model.LocalizedString.t() | nil, deviceContext: GoogleApi.WalletObjects.V1.Model.DeviceContext.t() | nil, disableExpirationNotification: boolean() | nil, groupingInfo: GoogleApi.WalletObjects.V1.Model.GroupingInfo.t() | nil, hasLinkedDevice: boolean() | nil, hasUsers: boolean() | nil, heroImage: GoogleApi.WalletObjects.V1.Model.Image.t() | nil, hexBackgroundColor: String.t() | nil, id: String.t() | nil, imageModulesData: [GoogleApi.WalletObjects.V1.Model.ImageModuleData.t()] | nil, infoModuleData: GoogleApi.WalletObjects.V1.Model.InfoModuleData.t() | nil, linksModuleData: GoogleApi.WalletObjects.V1.Model.LinksModuleData.t() | nil, locations: [GoogleApi.WalletObjects.V1.Model.LatLongPoint.t()] | nil, messages: [GoogleApi.WalletObjects.V1.Model.Message.t()] | nil, passConstraints: GoogleApi.WalletObjects.V1.Model.PassConstraints.t() | nil, passengerNames: String.t() | nil, passengerType: String.t() | nil, purchaseDetails: GoogleApi.WalletObjects.V1.Model.PurchaseDetails.t() | nil, rotatingBarcode: GoogleApi.WalletObjects.V1.Model.RotatingBarcode.t() | nil, smartTapRedemptionValue: String.t() | nil, state: String.t() | nil, textModulesData: [GoogleApi.WalletObjects.V1.Model.TextModuleData.t()] | nil, ticketLeg: GoogleApi.WalletObjects.V1.Model.TicketLeg.t() | nil, ticketLegs: [GoogleApi.WalletObjects.V1.Model.TicketLeg.t()] | nil, ticketNumber: String.t() | nil, ticketRestrictions: GoogleApi.WalletObjects.V1.Model.TicketRestrictions.t() | nil, ticketStatus: String.t() | nil, tripId: String.t() | nil, tripType: String.t() | nil, validTimeInterval: GoogleApi.WalletObjects.V1.Model.TimeInterval.t() | nil, version: String.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.