Class FlightClass

Inheritance
object
FlightClass
Implements
Inherited Members
Namespace: Google.Apis.Walletobjects.v1.Data
Assembly: Google.Apis.Walletobjects.v1.dll
Syntax
public class FlightClass : IDirectResponseSchema

Properties

AllowMultipleUsersPerObject

Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead.

Declaration
[JsonProperty("allowMultipleUsersPerObject")]
public virtual bool? AllowMultipleUsersPerObject { get; set; }
Property Value
Type Description
bool?

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 object that will be used instead.

Declaration
[JsonProperty("appLinkData")]
public virtual AppLinkData AppLinkData { get; set; }
Property Value
Type Description
AppLinkData

BoardingAndSeatingPolicy

Policies for boarding and seating. These will inform which labels will be shown to users.

Declaration
[JsonProperty("boardingAndSeatingPolicy")]
public virtual BoardingAndSeatingPolicy BoardingAndSeatingPolicy { get; set; }
Property Value
Type Description
BoardingAndSeatingPolicy

CallbackOptions

Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.

Declaration
[JsonProperty("callbackOptions")]
public virtual CallbackOptions CallbackOptions { get; set; }
Property Value
Type Description
CallbackOptions

ClassTemplateInfo

Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.

Declaration
[JsonProperty("classTemplateInfo")]
public virtual ClassTemplateInfo ClassTemplateInfo { get; set; }
Property Value
Type Description
ClassTemplateInfo

CountryCode

Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.

Declaration
[JsonProperty("countryCode")]
public virtual string CountryCode { get; set; }
Property Value
Type Description
string

Destination

Required. Destination airport.

Declaration
[JsonProperty("destination")]
public virtual AirportInfo Destination { get; set; }
Property Value
Type Description
AirportInfo

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EnableSmartTap

Identifies whether this class supports Smart Tap. The redemptionIssuers and object level smartTapRedemptionLevel fields must also be set up correctly in order for a pass to support Smart Tap.

Declaration
[JsonProperty("enableSmartTap")]
public virtual bool? EnableSmartTap { get; set; }
Property Value
Type Description
bool?

FlightHeader

Required. Information about the flight carrier and number.

Declaration
[JsonProperty("flightHeader")]
public virtual FlightHeader FlightHeader { get; set; }
Property Value
Type Description
FlightHeader

FlightStatus

Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.

Declaration
[JsonProperty("flightStatus")]
public virtual string FlightStatus { get; set; }
Property Value
Type Description
string

HeroImage

Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.

Declaration
[JsonProperty("heroImage")]
public virtual Image HeroImage { get; set; }
Property Value
Type Description
Image

HexBackgroundColor

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.

Declaration
[JsonProperty("hexBackgroundColor")]
public virtual string HexBackgroundColor { get; set; }
Property Value
Type Description
string

HomepageUri

The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).

Declaration
[JsonProperty("homepageUri")]
public virtual Uri HomepageUri { get; set; }
Property Value
Type Description
Uri

Id

Required. The unique identifier for a class. This ID must be unique across all classes 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. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.

Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
Type Description
string

ImageModulesData

Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.

Declaration
[JsonProperty("imageModulesData")]
public virtual IList<ImageModuleData> ImageModulesData { get; set; }
Property Value
Type Description
IList<ImageModuleData>

InfoModuleData

Deprecated. Use textModulesData instead.

Declaration
[JsonProperty("infoModuleData")]
public virtual InfoModuleData InfoModuleData { get; set; }
Property Value
Type Description
InfoModuleData

IssuerName

Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.

Declaration
[JsonProperty("issuerName")]
public virtual string IssuerName { get; set; }
Property Value
Type Description
string

Kind

Identifies what kind of resource this is. Value: the fixed string "walletobjects#flightClass".

Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
Type Description
string

LanguageOverride

If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Declaration
[JsonProperty("languageOverride")]
public virtual string LanguageOverride { get; set; }
Property Value
Type Description
string

LinksModuleData

Links module data. If links module data is also defined on the object, both will be displayed.

Declaration
[JsonProperty("linksModuleData")]
public virtual LinksModuleData LinksModuleData { get; set; }
Property Value
Type Description
LinksModuleData

LocalBoardingDateTime

The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.

Declaration
[JsonProperty("localBoardingDateTime")]
public virtual string LocalBoardingDateTime { get; set; }
Property Value
Type Description
string

LocalEstimatedOrActualArrivalDateTime

The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport.

Declaration
[JsonProperty("localEstimatedOrActualArrivalDateTime")]
public virtual string LocalEstimatedOrActualArrivalDateTime { get; set; }
Property Value
Type Description
string

LocalEstimatedOrActualDepartureDateTime

The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.

Declaration
[JsonProperty("localEstimatedOrActualDepartureDateTime")]
public virtual string LocalEstimatedOrActualDepartureDateTime { get; set; }
Property Value
Type Description
string

LocalGateClosingDateTime

The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.

Declaration
[JsonProperty("localGateClosingDateTime")]
public virtual string LocalGateClosingDateTime { get; set; }
Property Value
Type Description
string

LocalScheduledArrivalDateTime

The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set localEstimatedOrActualArrivalDateTime. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport.

Declaration
[JsonProperty("localScheduledArrivalDateTime")]
public virtual string LocalScheduledArrivalDateTime { get; set; }
Property Value
Type Description
string

LocalScheduledDepartureDateTime

Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set localEstimatedOrActualDepartureDateTime. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.

Declaration
[JsonProperty("localScheduledDepartureDateTime")]
public virtual string LocalScheduledDepartureDateTime { get; set; }
Property Value
Type Description
string

LocalizedIssuerName

Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.

Declaration
[JsonProperty("localizedIssuerName")]
public virtual LocalizedString LocalizedIssuerName { get; set; }
Property Value
Type Description
LocalizedString

Locations

Note: This field is currently not supported to trigger geo notifications.

Declaration
[JsonProperty("locations")]
public virtual IList<LatLongPoint> Locations { get; set; }
Property Value
Type Description
IList<LatLongPoint>

MerchantLocations

Merchant locations. There is a maximum of ten on the class. Any additional MerchantLocations added beyond the 10 will be rejected by the validator. These locations will trigger a notification when a user enters within a Google-set radius of the point. This field replaces the deprecated LatLongPoints.

Declaration
[JsonProperty("merchantLocations")]
public virtual IList<MerchantLocation> MerchantLocations { get; set; }
Property Value
Type Description
IList<MerchantLocation>

Messages

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.

Declaration
[JsonProperty("messages")]
public virtual IList<Message> Messages { get; set; }
Property Value
Type Description
IList<Message>

MultipleDevicesAndHoldersAllowedStatus

Identifies whether multiple users and devices will save the same object referencing this class.

Declaration
[JsonProperty("multipleDevicesAndHoldersAllowedStatus")]
public virtual string MultipleDevicesAndHoldersAllowedStatus { get; set; }
Property Value
Type Description
string

NotifyPreference

Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.

Declaration
[JsonProperty("notifyPreference")]
public virtual string NotifyPreference { get; set; }
Property Value
Type Description
string

Origin

Required. Origin airport.

Declaration
[JsonProperty("origin")]
public virtual AirportInfo Origin { get; set; }
Property Value
Type Description
AirportInfo

RedemptionIssuers

Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The enableSmartTap and object level smartTapRedemptionLevel fields must also be set up correctly in order for a pass to support Smart Tap.

Declaration
[JsonProperty("redemptionIssuers")]
public virtual IList<long?> RedemptionIssuers { get; set; }
Property Value
Type Description
IList<long?>

Review

The review comments set by the platform when a class is marked approved or rejected.

Declaration
[JsonProperty("review")]
public virtual Review Review { get; set; }
Property Value
Type Description
Review

ReviewStatus

Required. The status of the class. This field can be set to draft or underReview using the insert, patch, or update API calls. Once the review state is changed from draft it may not be changed back to draft. You should keep this field to draft when the class is under development. A draft class cannot be used to create any object. You should set this field to underReview when you believe the class is ready for use. The platform will automatically set this field to approved and it can be immediately used to create or migrate objects. When updating an already approved class you should keep setting this field to underReview.

Declaration
[JsonProperty("reviewStatus")]
public virtual string ReviewStatus { get; set; }
Property Value
Type Description
string

SecurityAnimation

Optional information about the security animation. If this is set a security animation will be rendered on pass details.

Declaration
[JsonProperty("securityAnimation")]
public virtual SecurityAnimation SecurityAnimation { get; set; }
Property Value
Type Description
SecurityAnimation

TextModulesData

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.

Declaration
[JsonProperty("textModulesData")]
public virtual IList<TextModuleData> TextModulesData { get; set; }
Property Value
Type Description
IList<TextModuleData>

ValueAddedModuleData

Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.

Declaration
[JsonProperty("valueAddedModuleData")]
public virtual IList<ValueAddedModuleData> ValueAddedModuleData { get; set; }
Property Value
Type Description
IList<ValueAddedModuleData>

Version

Deprecated

Declaration
[JsonProperty("version")]
public virtual long? Version { get; set; }
Property Value
Type Description
long?

ViewUnlockRequirement

View Unlock Requirement options for the boarding pass.

Declaration
[JsonProperty("viewUnlockRequirement")]
public virtual string ViewUnlockRequirement { get; set; }
Property Value
Type Description
string

WordMark

Deprecated.

Declaration
[JsonProperty("wordMark")]
public virtual Image WordMark { get; set; }
Property Value
Type Description
Image

Implements