Class: Google::Apis::WalletobjectsV1::TransitObject
- Inherits:
-
Object
- Object
- Google::Apis::WalletobjectsV1::TransitObject
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/walletobjects_v1/classes.rb,
lib/google/apis/walletobjects_v1/representations.rb,
lib/google/apis/walletobjects_v1/representations.rb
Instance Attribute Summary collapse
-
#activation_status ⇒ Google::Apis::WalletobjectsV1::ActivationStatus
The activation status of the object.
-
#app_link_data ⇒ Google::Apis::WalletobjectsV1::AppLinkData
Optional app or website link that will be displayed as a button on the front of the pass.
-
#barcode ⇒ Google::Apis::WalletobjectsV1::Barcode
The barcode type and value.
-
#class_id ⇒ String
Required.
-
#class_reference ⇒ Google::Apis::WalletobjectsV1::TransitClass
A copy of the inherited fields of the parent class.
-
#concession_category ⇒ String
The concession category for the ticket.
-
#custom_concession_category ⇒ Google::Apis::WalletobjectsV1::LocalizedString
A custom concession category to use when
concessionCategory
does not provide the right option. -
#custom_ticket_status ⇒ Google::Apis::WalletobjectsV1::LocalizedString
A custom status to use for the ticket status value when
ticketStatus
does not provide the right option. -
#device_context ⇒ Google::Apis::WalletobjectsV1::DeviceContext
Device context associated with the object.
-
#disable_expiration_notification ⇒ Boolean
(also: #disable_expiration_notification?)
Indicates if notifications should explicitly be suppressed.
-
#grouping_info ⇒ Google::Apis::WalletobjectsV1::GroupingInfo
Information that controls how passes are grouped together.
-
#has_linked_device ⇒ Boolean
(also: #has_linked_device?)
Whether this object is currently linked to a single device.
-
#has_users ⇒ Boolean
(also: #has_users?)
Indicates if the object has users.
-
#hero_image ⇒ Google::Apis::WalletobjectsV1::Image
Wrapping type for Google hosted images.
-
#hex_background_color ⇒ String
The background color for the card.
-
#id ⇒ String
Required.
-
#image_modules_data ⇒ Array<Google::Apis::WalletobjectsV1::ImageModuleData>
Image module data.
-
#info_module_data ⇒ Google::Apis::WalletobjectsV1::InfoModuleData
Deprecated.
-
#links_module_data ⇒ Google::Apis::WalletobjectsV1::LinksModuleData
Links module data.
-
#locations ⇒ Array<Google::Apis::WalletobjectsV1::LatLongPoint>
Note: This field is currently not supported to trigger geo notifications.
-
#messages ⇒ Array<Google::Apis::WalletobjectsV1::Message>
An array of messages displayed in the app.
-
#pass_constraints ⇒ Google::Apis::WalletobjectsV1::PassConstraints
Container for any constraints that may be placed on passes.
-
#passenger_names ⇒ String
The name(s) of the passengers the ticket is assigned to.
-
#passenger_type ⇒ String
The number of passengers.
-
#purchase_details ⇒ Google::Apis::WalletobjectsV1::PurchaseDetails
Purchase details for this ticket.
-
#rotating_barcode ⇒ Google::Apis::WalletobjectsV1::RotatingBarcode
The rotating barcode type and value.
-
#smart_tap_redemption_value ⇒ String
The value that will be transmitted to a Smart Tap certified terminal over NFC for this object.
-
#state ⇒ String
Required.
-
#text_modules_data ⇒ Array<Google::Apis::WalletobjectsV1::TextModuleData>
Text module data.
-
#ticket_leg ⇒ Google::Apis::WalletobjectsV1::TicketLeg
A single ticket leg contains departure and arrival information along with boarding and seating information.
-
#ticket_legs ⇒ Array<Google::Apis::WalletobjectsV1::TicketLeg>
Each ticket may contain one or more legs.
-
#ticket_number ⇒ String
The number of the ticket.
-
#ticket_restrictions ⇒ Google::Apis::WalletobjectsV1::TicketRestrictions
Information about what kind of restrictions there are on using this ticket.
-
#ticket_status ⇒ String
The status of the ticket.
-
#trip_id ⇒ String
This id is used to group tickets together if the user has saved multiple tickets for the same trip.
-
#trip_type ⇒ String
Required.
-
#valid_time_interval ⇒ Google::Apis::WalletobjectsV1::TimeInterval
The time period this object will be
active
and object can be used. -
#version ⇒ Fixnum
Deprecated Corresponds to the JSON property
version
.
Instance Method Summary collapse
-
#initialize(**args) ⇒ TransitObject
constructor
A new instance of TransitObject.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ TransitObject
Returns a new instance of TransitObject.
8073 8074 8075 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8073 def initialize(**args) update!(**args) end |
Instance Attribute Details
#activation_status ⇒ Google::Apis::WalletobjectsV1::ActivationStatus
The activation status of the object. This field includes activation status if
valuable supports activation.
Corresponds to the JSON property activationStatus
7835 7836 7837 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7835 def activation_status @activation_status end |
#app_link_data ⇒ Google::Apis::WalletobjectsV1::AppLinkData
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.
Corresponds to the JSON property appLinkData
7842 7843 7844 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7842 def app_link_data @app_link_data end |
#barcode ⇒ Google::Apis::WalletobjectsV1::Barcode
The barcode type and value.
Corresponds to the JSON property barcode
7847 7848 7849 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7847 def @barcode end |
#class_id ⇒ String
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.
Corresponds to the JSON property classId
7855 7856 7857 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7855 def class_id @class_id end |
#class_reference ⇒ Google::Apis::WalletobjectsV1::TransitClass
A copy of the inherited fields of the parent class. These fields are retrieved
during a GET.
Corresponds to the JSON property classReference
7861 7862 7863 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7861 def class_reference @class_reference end |
#concession_category ⇒ String
The concession category for the ticket.
Corresponds to the JSON property concessionCategory
7866 7867 7868 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7866 def concession_category @concession_category end |
#custom_concession_category ⇒ Google::Apis::WalletobjectsV1::LocalizedString
A custom concession category to use when concessionCategory
does not provide
the right option. Both concessionCategory
and customConcessionCategory
may
not be set.
Corresponds to the JSON property customConcessionCategory
7873 7874 7875 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7873 def custom_concession_category @custom_concession_category end |
#custom_ticket_status ⇒ Google::Apis::WalletobjectsV1::LocalizedString
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.
Corresponds to the JSON property customTicketStatus
7880 7881 7882 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7880 def custom_ticket_status @custom_ticket_status end |
#device_context ⇒ Google::Apis::WalletobjectsV1::DeviceContext
Device context associated with the object.
Corresponds to the JSON property deviceContext
7885 7886 7887 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7885 def device_context @device_context end |
#disable_expiration_notification ⇒ Boolean Also known as: disable_expiration_notification?
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.
Corresponds to the JSON property disableExpirationNotification
7893 7894 7895 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7893 def disable_expiration_notification @disable_expiration_notification end |
#grouping_info ⇒ Google::Apis::WalletobjectsV1::GroupingInfo
Information that controls how passes are grouped together.
Corresponds to the JSON property groupingInfo
7899 7900 7901 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7899 def grouping_info @grouping_info end |
#has_linked_device ⇒ Boolean Also known as: has_linked_device?
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.
Corresponds to the JSON property hasLinkedDevice
7907 7908 7909 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7907 def has_linked_device @has_linked_device end |
#has_users ⇒ Boolean Also known as: has_users?
Indicates if the object has users. This field is set by the platform.
Corresponds to the JSON property hasUsers
7913 7914 7915 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7913 def has_users @has_users end |
#hero_image ⇒ Google::Apis::WalletobjectsV1::Image
Wrapping type for Google hosted images. Next ID: 7
Corresponds to the JSON property heroImage
7919 7920 7921 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7919 def hero_image @hero_image end |
#hex_background_color ⇒ String
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
.
Corresponds to the JSON property hexBackgroundColor
7928 7929 7930 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7928 def hex_background_color @hex_background_color end |
#id ⇒ String
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 '-'.
Corresponds to the JSON property id
7937 7938 7939 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7937 def id @id end |
#image_modules_data ⇒ Array<Google::Apis::WalletobjectsV1::ImageModuleData>
Image module data. The maximum number of these fields displayed is 1 from
object level and 1 for class object level.
Corresponds to the JSON property imageModulesData
7943 7944 7945 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7943 def image_modules_data @image_modules_data end |
#info_module_data ⇒ Google::Apis::WalletobjectsV1::InfoModuleData
Deprecated. Use textModulesData instead.
Corresponds to the JSON property infoModuleData
7948 7949 7950 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7948 def info_module_data @info_module_data end |
#links_module_data ⇒ Google::Apis::WalletobjectsV1::LinksModuleData
Links module data. If links module data is also defined on the class, both
will be displayed.
Corresponds to the JSON property linksModuleData
7954 7955 7956 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7954 def links_module_data @links_module_data end |
#locations ⇒ Array<Google::Apis::WalletobjectsV1::LatLongPoint>
Note: This field is currently not supported to trigger geo notifications.
Corresponds to the JSON property locations
7959 7960 7961 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7959 def locations @locations end |
#messages ⇒ Array<Google::Apis::WalletobjectsV1::Message>
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.
Corresponds to the JSON property messages
7965 7966 7967 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7965 def @messages end |
#pass_constraints ⇒ Google::Apis::WalletobjectsV1::PassConstraints
Container for any constraints that may be placed on passes.
Corresponds to the JSON property passConstraints
7970 7971 7972 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7970 def pass_constraints @pass_constraints end |
#passenger_names ⇒ String
The name(s) of the passengers the ticket is assigned to. The above
passengerType
field is meant to give Google context on this field.
Corresponds to the JSON property passengerNames
7976 7977 7978 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7976 def passenger_names @passenger_names end |
#passenger_type ⇒ String
The number of passengers.
Corresponds to the JSON property passengerType
7981 7982 7983 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7981 def passenger_type @passenger_type end |
#purchase_details ⇒ Google::Apis::WalletobjectsV1::PurchaseDetails
Purchase details for this ticket.
Corresponds to the JSON property purchaseDetails
7986 7987 7988 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7986 def purchase_details @purchase_details end |
#rotating_barcode ⇒ Google::Apis::WalletobjectsV1::RotatingBarcode
The rotating barcode type and value.
Corresponds to the JSON property rotatingBarcode
7991 7992 7993 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7991 def @rotating_barcode end |
#smart_tap_redemption_value ⇒ String
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.
Corresponds to the JSON property smartTapRedemptionValue
7999 8000 8001 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 7999 def smart_tap_redemption_value @smart_tap_redemption_value end |
#state ⇒ String
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.
Corresponds to the JSON property state
8006 8007 8008 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8006 def state @state end |
#text_modules_data ⇒ Array<Google::Apis::WalletobjectsV1::TextModuleData>
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.
Corresponds to the JSON property textModulesData
8013 8014 8015 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8013 def text_modules_data @text_modules_data end |
#ticket_leg ⇒ Google::Apis::WalletobjectsV1::TicketLeg
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 the ticketLegs
field instead. Both ticketLeg
and ticketLegs
may not
be set.
Corresponds to the JSON property ticketLeg
8021 8022 8023 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8021 def ticket_leg @ticket_leg end |
#ticket_legs ⇒ Array<Google::Apis::WalletobjectsV1::TicketLeg>
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 the ticketLeg
field instead. Both ticketLeg
and ticketLegs
may not be set.
Corresponds to the JSON property ticketLegs
8029 8030 8031 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8029 def ticket_legs @ticket_legs end |
#ticket_number ⇒ String
The number of the ticket. This is a unique identifier for the ticket in the
transit operator's system.
Corresponds to the JSON property ticketNumber
8035 8036 8037 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8035 def ticket_number @ticket_number end |
#ticket_restrictions ⇒ Google::Apis::WalletobjectsV1::TicketRestrictions
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.
Corresponds to the JSON property ticketRestrictions
8042 8043 8044 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8042 def ticket_restrictions @ticket_restrictions end |
#ticket_status ⇒ String
The status of the ticket. For states which affect display, use the state
field instead.
Corresponds to the JSON property ticketStatus
8048 8049 8050 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8048 def ticket_status @ticket_status end |
#trip_id ⇒ String
This id is used to group tickets together if the user has saved multiple
tickets for the same trip.
Corresponds to the JSON property tripId
8054 8055 8056 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8054 def trip_id @trip_id end |
#trip_type ⇒ String
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.
Corresponds to the JSON property tripType
8060 8061 8062 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8060 def trip_type @trip_type end |
#valid_time_interval ⇒ Google::Apis::WalletobjectsV1::TimeInterval
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.
Corresponds to the JSON property validTimeInterval
8066 8067 8068 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8066 def valid_time_interval @valid_time_interval end |
#version ⇒ Fixnum
Deprecated
Corresponds to the JSON property version
8071 8072 8073 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8071 def version @version end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8078 def update!(**args) @activation_status = args[:activation_status] if args.key?(:activation_status) @app_link_data = args[:app_link_data] if args.key?(:app_link_data) @barcode = args[:barcode] if args.key?(:barcode) @class_id = args[:class_id] if args.key?(:class_id) @class_reference = args[:class_reference] if args.key?(:class_reference) @concession_category = args[:concession_category] if args.key?(:concession_category) @custom_concession_category = args[:custom_concession_category] if args.key?(:custom_concession_category) @custom_ticket_status = args[:custom_ticket_status] if args.key?(:custom_ticket_status) @device_context = args[:device_context] if args.key?(:device_context) @disable_expiration_notification = args[:disable_expiration_notification] if args.key?(:disable_expiration_notification) @grouping_info = args[:grouping_info] if args.key?(:grouping_info) @has_linked_device = args[:has_linked_device] if args.key?(:has_linked_device) @has_users = args[:has_users] if args.key?(:has_users) @hero_image = args[:hero_image] if args.key?(:hero_image) @hex_background_color = args[:hex_background_color] if args.key?(:hex_background_color) @id = args[:id] if args.key?(:id) @image_modules_data = args[:image_modules_data] if args.key?(:image_modules_data) @info_module_data = args[:info_module_data] if args.key?(:info_module_data) @links_module_data = args[:links_module_data] if args.key?(:links_module_data) @locations = args[:locations] if args.key?(:locations) @messages = args[:messages] if args.key?(:messages) @pass_constraints = args[:pass_constraints] if args.key?(:pass_constraints) @passenger_names = args[:passenger_names] if args.key?(:passenger_names) @passenger_type = args[:passenger_type] if args.key?(:passenger_type) @purchase_details = args[:purchase_details] if args.key?(:purchase_details) @rotating_barcode = args[:rotating_barcode] if args.key?(:rotating_barcode) @smart_tap_redemption_value = args[:smart_tap_redemption_value] if args.key?(:smart_tap_redemption_value) @state = args[:state] if args.key?(:state) @text_modules_data = args[:text_modules_data] if args.key?(:text_modules_data) @ticket_leg = args[:ticket_leg] if args.key?(:ticket_leg) @ticket_legs = args[:ticket_legs] if args.key?(:ticket_legs) @ticket_number = args[:ticket_number] if args.key?(:ticket_number) @ticket_restrictions = args[:ticket_restrictions] if args.key?(:ticket_restrictions) @ticket_status = args[:ticket_status] if args.key?(:ticket_status) @trip_id = args[:trip_id] if args.key?(:trip_id) @trip_type = args[:trip_type] if args.key?(:trip_type) @valid_time_interval = args[:valid_time_interval] if args.key?(:valid_time_interval) @version = args[:version] if args.key?(:version) end |