GenericClass

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

Generic Class

interface GenericClass {

appLinkData?: AppLinkData;

callbackOptions?: CallbackOptions;

classTemplateInfo?: ClassTemplateInfo;

enableSmartTap?: boolean;

id?: string;

imageModulesData?: ImageModuleData[];

linksModuleData?: LinksModuleData;

messages?: Message[];

multipleDevicesAndHoldersAllowedStatus?:

| "STATUS_UNSPECIFIED"

| "MULTIPLE_HOLDERS"

| "ONE_USER_ALL_DEVICES"

| "ONE_USER_ONE_DEVICE"

| "multipleHolders"

| "oneUserAllDevices"

| "oneUserOneDevice";

redemptionIssuers?: bigint[];

securityAnimation?: SecurityAnimation;

textModulesData?: TextModuleData[];

viewUnlockRequirement?: "VIEW_UNLOCK_REQUIREMENT_UNSPECIFIED" | "UNLOCK_NOT_REQUIRED" | "UNLOCK_REQUIRED_TO_VIEW";

}

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

callbackOptions?: CallbackOptions

[src]

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.

classTemplateInfo?: ClassTemplateInfo

[src]

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

enableSmartTap?: boolean

[src]

Available only to Smart Tap enabled partners. Contact support for additional guidance.

id?: string

[src]

Required. The unique identifier for the class. This ID must be unique across all 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. If imageModulesData is also defined on the object, both will be displayed. 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 object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.

messages?: Message[]

[src]

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.

[src]

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

redemptionIssuers?: bigint[]

[src]

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.

securityAnimation?: SecurityAnimation

[src]

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

textModulesData?: TextModuleData[]

[src]

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

viewUnlockRequirement?: "VIEW_UNLOCK_REQUIREMENT_UNSPECIFIED" | "UNLOCK_NOT_REQUIRED" | "UNLOCK_REQUIRED_TO_VIEW"

[src]

View Unlock Requirement options for the generic pass.