View Source GoogleApi.WalletObjects.V1.Model.GenericObject (google_api_wallet_objects v0.3.0)
Generic Object Next ID: 121
Attributes
-
appLinkData
(type:GoogleApi.WalletObjects.V1.Model.AppLinkData.t
, default:nil
) - Information about the partner app link. The maximum number of these fields displayed is 10. -
barcode
(type:GoogleApi.WalletObjects.V1.Model.Barcode.t
, default:nil
) - 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
(type:GoogleApi.WalletObjects.V1.Model.LocalizedString.t
, default:nil
) - 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
(type:String.t
, default:nil
) - 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 formatissuerID.identifier
whereissuerID
is issued by Google andidentifier
is chosen by you. -
genericType
(type:String.t
, default:nil
) - Specify whichGenericType
the card belongs to. -
groupingInfo
(type:GoogleApi.WalletObjects.V1.Model.GroupingInfo.t
, default:nil
) - Information that controls how passes are grouped together. -
hasUsers
(type:boolean()
, default:nil
) - Indicates if the object has users. This field is set by the platform. -
header
(type:GoogleApi.WalletObjects.V1.Model.LocalizedString.t
, default:nil
) - Required. The title of the pass, such as "50% off coupon" or "Library card" or "Voucher". This field is required and appears in the title row of the pass detail view. -
heroImage
(type:GoogleApi.WalletObjects.V1.Model.Image.t
, default:nil
) - Banner image displayed on the front of the card if present. The image will be displayed at 100% width. -
hexBackgroundColor
(type:String.t
, default:nil
) - 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
(type:String.t
, default:nil
) - Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value needs to follow the formatissuerID.identifier
whereissuerID
is issued by Google andidentifier
is chosen by you. The unique identifier can only include alphanumeric characters,.
,_
, or-
. -
imageModulesData
(type:list(GoogleApi.WalletObjects.V1.Model.ImageModuleData.t)
, default:nil
) - Image module data. Only one of the image from class and one from object level will be rendered when both set. -
linksModuleData
(type:GoogleApi.WalletObjects.V1.Model.LinksModuleData.t
, default:nil
) - Links module data. IflinksModuleData
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. -
logo
(type:GoogleApi.WalletObjects.V1.Model.Image.t
, default:nil
) - The logo image of the pass. This image is displayed in the card detail view in upper left, and also on the list/thumbnail view. If the logo is not present, the first letter ofcardTitle
would be shown as logo. -
notifications
(type:GoogleApi.WalletObjects.V1.Model.Notifications.t
, default:nil
) - The notification settings that are enabled for this object. -
passConstraints
(type:GoogleApi.WalletObjects.V1.Model.PassConstraints.t
, default:nil
) - Pass constraints for the object. Includes limiting NFC and screenshot behaviors. -
rotatingBarcode
(type:GoogleApi.WalletObjects.V1.Model.RotatingBarcode.t
, default:nil
) - The rotating barcode settings/details. -
smartTapRedemptionValue
(type:String.t
, default:nil
) - The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fieldsenableSmartTap
andredemptionIssuers
must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. -
state
(type:String.t
, default:nil
) - The state of the object. This field is used to determine how an object is displayed in the app. For example, aninactive
object is moved to the "Expired passes" section. If this is not provided, the object would be consideredACTIVE
. -
subheader
(type:GoogleApi.WalletObjects.V1.Model.LocalizedString.t
, default:nil
) - 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
(type:list(GoogleApi.WalletObjects.V1.Model.TextModuleData.t)
, default:nil
) - Text module data. IftextModulesData
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
(type:GoogleApi.WalletObjects.V1.Model.TimeInterval.t
, default:nil
) - 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. -
wideLogo
(type:GoogleApi.WalletObjects.V1.Model.Image.t
, default:nil
) - The wide logo of the pass. When provided, this will be used in place of the logo in the top left of the card view.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.WalletObjects.V1.Model.GenericObject{ appLinkData: GoogleApi.WalletObjects.V1.Model.AppLinkData.t() | nil, barcode: GoogleApi.WalletObjects.V1.Model.Barcode.t() | nil, cardTitle: GoogleApi.WalletObjects.V1.Model.LocalizedString.t() | nil, classId: String.t() | nil, genericType: String.t() | nil, groupingInfo: GoogleApi.WalletObjects.V1.Model.GroupingInfo.t() | nil, hasUsers: boolean() | nil, header: GoogleApi.WalletObjects.V1.Model.LocalizedString.t() | nil, heroImage: GoogleApi.WalletObjects.V1.Model.Image.t() | nil, hexBackgroundColor: String.t() | nil, id: String.t() | nil, imageModulesData: [GoogleApi.WalletObjects.V1.Model.ImageModuleData.t()] | nil, linksModuleData: GoogleApi.WalletObjects.V1.Model.LinksModuleData.t() | nil, logo: GoogleApi.WalletObjects.V1.Model.Image.t() | nil, notifications: GoogleApi.WalletObjects.V1.Model.Notifications.t() | nil, passConstraints: GoogleApi.WalletObjects.V1.Model.PassConstraints.t() | nil, rotatingBarcode: GoogleApi.WalletObjects.V1.Model.RotatingBarcode.t() | nil, smartTapRedemptionValue: String.t() | nil, state: String.t() | nil, subheader: GoogleApi.WalletObjects.V1.Model.LocalizedString.t() | nil, textModulesData: [GoogleApi.WalletObjects.V1.Model.TextModuleData.t()] | nil, validTimeInterval: GoogleApi.WalletObjects.V1.Model.TimeInterval.t() | nil, wideLogo: GoogleApi.WalletObjects.V1.Model.Image.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.