Class: Google::Apis::WalletobjectsV1::FlightObject
- Inherits:
-
Object
- Object
- Google::Apis::WalletobjectsV1::FlightObject
- 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
-
#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.
-
#boarding_and_seating_info ⇒ Google::Apis::WalletobjectsV1::BoardingAndSeatingInfo
Passenger specific information about boarding and seating.
-
#class_id ⇒ String
Required.
-
#class_reference ⇒ Google::Apis::WalletobjectsV1::FlightClass
A copy of the inherited fields of the parent class.
-
#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.
-
#kind ⇒ String
Identifies what kind of resource this is.
-
#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_name ⇒ String
Required.
-
#reservation_info ⇒ Google::Apis::WalletobjectsV1::ReservationInfo
Required.
-
#rotating_barcode ⇒ Google::Apis::WalletobjectsV1::RotatingBarcode
The rotating barcode type and value.
-
#security_program_logo ⇒ Google::Apis::WalletobjectsV1::Image
Wrapping type for Google hosted images.
-
#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.
-
#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) ⇒ FlightObject
constructor
A new instance of FlightObject.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ FlightObject
Returns a new instance of FlightObject.
2974 2975 2976 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2974 def initialize(**args) update!(**args) end |
Instance Attribute Details
#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
2803 2804 2805 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2803 def app_link_data @app_link_data end |
#barcode ⇒ Google::Apis::WalletobjectsV1::Barcode
The barcode type and value.
Corresponds to the JSON property barcode
2808 2809 2810 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2808 def @barcode end |
#boarding_and_seating_info ⇒ Google::Apis::WalletobjectsV1::BoardingAndSeatingInfo
Passenger specific information about boarding and seating.
Corresponds to the JSON property boardingAndSeatingInfo
2813 2814 2815 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2813 def boarding_and_seating_info @boarding_and_seating_info 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
2821 2822 2823 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2821 def class_id @class_id end |
#class_reference ⇒ Google::Apis::WalletobjectsV1::FlightClass
A copy of the inherited fields of the parent class. These fields are retrieved
during a GET.
Corresponds to the JSON property classReference
2827 2828 2829 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2827 def class_reference @class_reference 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 Flights.
Corresponds to the JSON property disableExpirationNotification
2835 2836 2837 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2835 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
2841 2842 2843 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2841 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
2849 2850 2851 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2849 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
2855 2856 2857 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2855 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
2861 2862 2863 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2861 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
2870 2871 2872 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2870 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
2879 2880 2881 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2879 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
2885 2886 2887 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2885 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
2890 2891 2892 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2890 def info_module_data @info_module_data end |
#kind ⇒ String
Identifies what kind of resource this is. Value: the fixed string "
walletobjects#flightObject"
.
Corresponds to the JSON property kind
2896 2897 2898 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2896 def kind @kind 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
2902 2903 2904 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2902 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
2907 2908 2909 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2907 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
2913 2914 2915 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2913 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
2918 2919 2920 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2918 def pass_constraints @pass_constraints end |
#passenger_name ⇒ String
Required. Passenger name as it would appear on the boarding pass. eg: "Dave M
Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"
Corresponds to the JSON property passengerName
2924 2925 2926 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2924 def passenger_name @passenger_name end |
#reservation_info ⇒ Google::Apis::WalletobjectsV1::ReservationInfo
Required. Information about flight reservation.
Corresponds to the JSON property reservationInfo
2929 2930 2931 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2929 def reservation_info @reservation_info end |
#rotating_barcode ⇒ Google::Apis::WalletobjectsV1::RotatingBarcode
The rotating barcode type and value.
Corresponds to the JSON property rotatingBarcode
2934 2935 2936 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2934 def @rotating_barcode end |
#security_program_logo ⇒ Google::Apis::WalletobjectsV1::Image
Wrapping type for Google hosted images. Next ID: 7
Corresponds to the JSON property securityProgramLogo
2939 2940 2941 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2939 def security_program_logo @security_program_logo 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
2947 2948 2949 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2947 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
2954 2955 2956 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2954 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
2961 2962 2963 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2961 def text_modules_data @text_modules_data 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
2967 2968 2969 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2967 def valid_time_interval @valid_time_interval end |
#version ⇒ Fixnum
Deprecated
Corresponds to the JSON property version
2972 2973 2974 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2972 def version @version end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2979 def update!(**args) @app_link_data = args[:app_link_data] if args.key?(:app_link_data) @barcode = args[:barcode] if args.key?(:barcode) @boarding_and_seating_info = args[:boarding_and_seating_info] if args.key?(:boarding_and_seating_info) @class_id = args[:class_id] if args.key?(:class_id) @class_reference = args[:class_reference] if args.key?(:class_reference) @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) @kind = args[:kind] if args.key?(:kind) @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_name = args[:passenger_name] if args.key?(:passenger_name) @reservation_info = args[:reservation_info] if args.key?(:reservation_info) @rotating_barcode = args[:rotating_barcode] if args.key?(:rotating_barcode) @security_program_logo = args[:security_program_logo] if args.key?(:security_program_logo) @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) @valid_time_interval = args[:valid_time_interval] if args.key?(:valid_time_interval) @version = args[:version] if args.key?(:version) end |