Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

GenericObject

import type { GenericObject } from "https://googleapis.deno.dev/v1/walletobjects:v1.ts";

Generic Object

interface GenericObject {
appLinkData?: AppLinkData;
barcode?: Barcode;
cardTitle?: LocalizedString;
classId?: string;
genericType?:
| "GENERIC_TYPE_UNSPECIFIED"
| "GENERIC_SEASON_PASS"
| "GENERIC_UTILITY_BILLS"
| "GENERIC_PARKING_PASS"
| "GENERIC_VOUCHER"
| "GENERIC_GYM_MEMBERSHIP"
| "GENERIC_LIBRARY_MEMBERSHIP"
| "GENERIC_RESERVATIONS"
| "GENERIC_AUTO_INSURANCE"
| "GENERIC_HOME_INSURANCE"
| "GENERIC_ENTRY_TICKET"
| "GENERIC_RECEIPT"
| "GENERIC_OTHER";
groupingInfo?: GroupingInfo;
hasUsers?: boolean;
header?: LocalizedString;
heroImage?: Image;
hexBackgroundColor?: string;
id?: string;
imageModulesData?: ImageModuleData[];
linksModuleData?: LinksModuleData;
logo?: Image;
notifications?: Notifications;
passConstraints?: PassConstraints;
rotatingBarcode?: RotatingBarcode;
smartTapRedemptionValue?: string;
state?:
| "STATE_UNSPECIFIED"
| "ACTIVE"
| "active"
| "COMPLETED"
| "completed"
| "EXPIRED"
| "expired"
| "INACTIVE"
| "inactive";
subheader?: LocalizedString;
textModulesData?: TextModuleData[];
validTimeInterval?: TimeInterval;
wideLogo?: Image;
}

§Properties

§
appLinkData?: AppLinkData
[src]

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.

§
barcode?: Barcode
[src]

The barcode type and value. If pass does not have a barcode, we can allow the issuer to set Barcode.alternate_text and display just that.

§
cardTitle?: LocalizedString
[src]

Required. The header of the pass. This is usually the Business name such as "XXX Gym", "AAA Insurance". This field is required and appears in the header row at the very top of the pass.

§
classId?: string
[src]

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 issuerID.identifier where issuerID is issued by Google and identifier is chosen by you.

§
genericType?: "GENERIC_TYPE_UNSPECIFIED" | "GENERIC_SEASON_PASS" | "GENERIC_UTILITY_BILLS" | "GENERIC_PARKING_PASS" | "GENERIC_VOUCHER" | "GENERIC_GYM_MEMBERSHIP" | "GENERIC_LIBRARY_MEMBERSHIP" | "GENERIC_RESERVATIONS" | "GENERIC_AUTO_INSURANCE" | "GENERIC_HOME_INSURANCE" | "GENERIC_ENTRY_TICKET" | "GENERIC_RECEIPT" | "GENERIC_OTHER"
[src]

Specify which GenericType the card belongs to.

§
groupingInfo?: GroupingInfo
[src]

Information that controls how passes are grouped together.

§
hasUsers?: boolean
[src]

Indicates if the object has users. This field is set by the platform.

§
heroImage?: Image
[src]

Banner image displayed on the front of the card if present. The image will be displayed at 100% width.

§
hexBackgroundColor?: string
[src]

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 and if logo is not set, a color would be chosen by Google.

§
id?: string
[src]

Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value needs to follow the format issuerID.identifier where issuerID is issued by Google and identifier is chosen by you. The unique identifier can only include alphanumeric characters, ., _, or -.

§
imageModulesData?: ImageModuleData[]
[src]

Image module data. Only one of the image from class and one from object level will be rendered when both set.

§
linksModuleData?: LinksModuleData
[src]

Links module data. If linksModuleData is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.

§
notifications?: Notifications
[src]

The notification settings that are enabled for this object.

§
passConstraints?: PassConstraints
[src]

Pass constraints for the object. Includes limiting NFC and screenshot behaviors.

§
rotatingBarcode?: RotatingBarcode
[src]

The rotating barcode settings/details.

§
smartTapRedemptionValue?: string
[src]

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.

§
state?: "STATE_UNSPECIFIED" | "ACTIVE" | "active" | "COMPLETED" | "completed" | "EXPIRED" | "expired" | "INACTIVE" | "inactive"
[src]

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. If this is not provided, the object would be considered ACTIVE.

§
subheader?: LocalizedString
[src]

The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view.

§
textModulesData?: TextModuleData[]
[src]

Text module data. If textModulesData is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.

§
validTimeInterval?: TimeInterval
[src]

The time period this object will be considered valid or usable. When the time period is passed, the object will be considered expired, which will affect the rendering on user's devices.