LoyaltyClass (Google Wallet API v1-rev20250506-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.walletobjects.model.LoyaltyClass

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class LoyaltyClass
extends com.google.api.client.json.GenericJson
```
Model definition for LoyaltyClass.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Wallet API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

LoyaltyClass()

Constructors
Constructor and Description
`LoyaltyClass()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LoyaltyClass`	`clone()`
`String`	`getAccountIdLabel()` The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
`String`	`getAccountNameLabel()` The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
`Boolean`	`getAllowMultipleUsersPerObject()` Deprecated.
`AppLinkData`	`getAppLinkData()` Optional app or website link that will be displayed as a button on the front of the pass.
`CallbackOptions`	`getCallbackOptions()` Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user.
`ClassTemplateInfo`	`getClassTemplateInfo()` Template information about how the class should be displayed.
`String`	`getCountryCode()` 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.
`DiscoverableProgram`	`getDiscoverableProgram()` Information about how the class may be discovered and instantiated from within the Google Pay app.
`Boolean`	`getEnableSmartTap()` Identifies whether this class supports Smart Tap.
`Image`	`getHeroImage()` Optional banner image displayed on the front of the card.
`String`	`getHexBackgroundColor()` The background color for the card.
`Uri`	`getHomepageUri()` The URI of your application's home page.
`String`	`getId()` Required.
`List<ImageModuleData>`	`getImageModulesData()` Image module data.
`InfoModuleData`	`getInfoModuleData()` Deprecated.
`String`	`getIssuerName()` Required.
`String`	`getKind()` Identifies what kind of resource this is.
`LinksModuleData`	`getLinksModuleData()` Links module data.
`LocalizedString`	`getLocalizedAccountIdLabel()` Translated strings for the account_id_label.
`LocalizedString`	`getLocalizedAccountNameLabel()` Translated strings for the account_name_label.
`LocalizedString`	`getLocalizedIssuerName()` Translated strings for the issuer_name.
`LocalizedString`	`getLocalizedProgramName()` Translated strings for the program_name.
`LocalizedString`	`getLocalizedRewardsTier()` Translated strings for the rewards_tier.
`LocalizedString`	`getLocalizedRewardsTierLabel()` Translated strings for the rewards_tier_label.
`LocalizedString`	`getLocalizedSecondaryRewardsTier()` Translated strings for the secondary_rewards_tier.
`LocalizedString`	`getLocalizedSecondaryRewardsTierLabel()` Translated strings for the secondary_rewards_tier_label.
`List<LatLongPoint>`	`getLocations()` Note: This field is currently not supported to trigger geo notifications.
`List<MerchantLocation>`	`getMerchantLocations()` Merchant locations.
`List<Message>`	`getMessages()` An array of messages displayed in the app.
`String`	`getMultipleDevicesAndHoldersAllowedStatus()` Identifies whether multiple users and devices will save the same object referencing this class.
`String`	`getNotifyPreference()` Whether or not field updates to this class should trigger notifications.
`Image`	`getProgramLogo()` Required.
`String`	`getProgramName()` Required.
`List<Long>`	`getRedemptionIssuers()` Identifies which redemption issuers can redeem the pass over Smart Tap.
`Review`	`getReview()` The review comments set by the platform when a class is marked `approved` or `rejected`.
`String`	`getReviewStatus()` Required.
`String`	`getRewardsTier()` The rewards tier, such as "Gold" or "Platinum." Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
`String`	`getRewardsTierLabel()` The rewards tier label, such as "Rewards Tier." Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
`String`	`getSecondaryRewardsTier()` The secondary rewards tier, such as "Gold" or "Platinum."
`String`	`getSecondaryRewardsTierLabel()` The secondary rewards tier label, such as "Rewards Tier."
`SecurityAnimation`	`getSecurityAnimation()` Optional information about the security animation.
`List<TextModuleData>`	`getTextModulesData()` Text module data.
`List<ValueAddedModuleData>`	`getValueAddedModuleData()` Optional value added module data.
`Long`	`getVersion()` Deprecated
`String`	`getViewUnlockRequirement()` View Unlock Requirement options for the loyalty card.
`Image`	`getWideProgramLogo()` The wide logo of the loyalty program or company.
`Image`	`getWordMark()` Deprecated.
`LoyaltyClass`	`set(String fieldName, Object value)`
`LoyaltyClass`	`setAccountIdLabel(String accountIdLabel)` The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
`LoyaltyClass`	`setAccountNameLabel(String accountNameLabel)` The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
`LoyaltyClass`	`setAllowMultipleUsersPerObject(Boolean allowMultipleUsersPerObject)` Deprecated.
`LoyaltyClass`	`setAppLinkData(AppLinkData appLinkData)` Optional app or website link that will be displayed as a button on the front of the pass.
`LoyaltyClass`	`setCallbackOptions(CallbackOptions 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.
`LoyaltyClass`	`setClassTemplateInfo(ClassTemplateInfo classTemplateInfo)` Template information about how the class should be displayed.
`LoyaltyClass`	`setCountryCode(String 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.
`LoyaltyClass`	`setDiscoverableProgram(DiscoverableProgram discoverableProgram)` Information about how the class may be discovered and instantiated from within the Google Pay app.
`LoyaltyClass`	`setEnableSmartTap(Boolean enableSmartTap)` Identifies whether this class supports Smart Tap.
`LoyaltyClass`	`setHeroImage(Image heroImage)` Optional banner image displayed on the front of the card.
`LoyaltyClass`	`setHexBackgroundColor(String hexBackgroundColor)` The background color for the card.
`LoyaltyClass`	`setHomepageUri(Uri homepageUri)` The URI of your application's home page.
`LoyaltyClass`	`setId(String id)` Required.
`LoyaltyClass`	`setImageModulesData(List<ImageModuleData> imageModulesData)` Image module data.
`LoyaltyClass`	`setInfoModuleData(InfoModuleData infoModuleData)` Deprecated.
`LoyaltyClass`	`setIssuerName(String issuerName)` Required.
`LoyaltyClass`	`setKind(String kind)` Identifies what kind of resource this is.
`LoyaltyClass`	`setLinksModuleData(LinksModuleData linksModuleData)` Links module data.
`LoyaltyClass`	`setLocalizedAccountIdLabel(LocalizedString localizedAccountIdLabel)` Translated strings for the account_id_label.
`LoyaltyClass`	`setLocalizedAccountNameLabel(LocalizedString localizedAccountNameLabel)` Translated strings for the account_name_label.
`LoyaltyClass`	`setLocalizedIssuerName(LocalizedString localizedIssuerName)` Translated strings for the issuer_name.
`LoyaltyClass`	`setLocalizedProgramName(LocalizedString localizedProgramName)` Translated strings for the program_name.
`LoyaltyClass`	`setLocalizedRewardsTier(LocalizedString localizedRewardsTier)` Translated strings for the rewards_tier.
`LoyaltyClass`	`setLocalizedRewardsTierLabel(LocalizedString localizedRewardsTierLabel)` Translated strings for the rewards_tier_label.
`LoyaltyClass`	`setLocalizedSecondaryRewardsTier(LocalizedString localizedSecondaryRewardsTier)` Translated strings for the secondary_rewards_tier.
`LoyaltyClass`	`setLocalizedSecondaryRewardsTierLabel(LocalizedString localizedSecondaryRewardsTierLabel)` Translated strings for the secondary_rewards_tier_label.
`LoyaltyClass`	`setLocations(List<LatLongPoint> locations)` Note: This field is currently not supported to trigger geo notifications.
`LoyaltyClass`	`setMerchantLocations(List<MerchantLocation> merchantLocations)` Merchant locations.
`LoyaltyClass`	`setMessages(List<Message> messages)` An array of messages displayed in the app.
`LoyaltyClass`	`setMultipleDevicesAndHoldersAllowedStatus(String multipleDevicesAndHoldersAllowedStatus)` Identifies whether multiple users and devices will save the same object referencing this class.
`LoyaltyClass`	`setNotifyPreference(String notifyPreference)` Whether or not field updates to this class should trigger notifications.
`LoyaltyClass`	`setProgramLogo(Image programLogo)` Required.
`LoyaltyClass`	`setProgramName(String programName)` Required.
`LoyaltyClass`	`setRedemptionIssuers(List<Long> redemptionIssuers)` Identifies which redemption issuers can redeem the pass over Smart Tap.
`LoyaltyClass`	`setReview(Review review)` The review comments set by the platform when a class is marked `approved` or `rejected`.
`LoyaltyClass`	`setReviewStatus(String reviewStatus)` Required.
`LoyaltyClass`	`setRewardsTier(String rewardsTier)` The rewards tier, such as "Gold" or "Platinum." Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
`LoyaltyClass`	`setRewardsTierLabel(String rewardsTierLabel)` The rewards tier label, such as "Rewards Tier." Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
`LoyaltyClass`	`setSecondaryRewardsTier(String secondaryRewardsTier)` The secondary rewards tier, such as "Gold" or "Platinum."
`LoyaltyClass`	`setSecondaryRewardsTierLabel(String secondaryRewardsTierLabel)` The secondary rewards tier label, such as "Rewards Tier."
`LoyaltyClass`	`setSecurityAnimation(SecurityAnimation securityAnimation)` Optional information about the security animation.
`LoyaltyClass`	`setTextModulesData(List<TextModuleData> textModulesData)` Text module data.
`LoyaltyClass`	`setValueAddedModuleData(List<ValueAddedModuleData> valueAddedModuleData)` Optional value added module data.
`LoyaltyClass`	`setVersion(Long version)` Deprecated
`LoyaltyClass`	`setViewUnlockRequirement(String viewUnlockRequirement)` View Unlock Requirement options for the loyalty card.
`LoyaltyClass`	`setWideProgramLogo(Image wideProgramLogo)` The wide logo of the loyalty program or company.
`LoyaltyClass`	`setWordMark(Image wordMark)` Deprecated.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - LoyaltyClass
```
public LoyaltyClass()
```
- Method Detail
  - getAccountIdLabel
```
public String getAccountIdLabel()
```
    The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
    
    Returns:
    
    value or null for none
  - setAccountIdLabel
```
public LoyaltyClass setAccountIdLabel(String accountIdLabel)
```
    The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
    
    Parameters:
    
    accountIdLabel - accountIdLabel or null for none
  - getAccountNameLabel
```
public String getAccountNameLabel()
```
    The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
    
    Returns:
    
    value or null for none
  - setAccountNameLabel
```
public LoyaltyClass setAccountNameLabel(String accountNameLabel)
```
    The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
    
    Parameters:
    
    accountNameLabel - accountNameLabel or null for none
  - getAllowMultipleUsersPerObject
```
public Boolean getAllowMultipleUsersPerObject()
```
    Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
    
    Returns:
    
    value or null for none
  - setAllowMultipleUsersPerObject
```
public LoyaltyClass setAllowMultipleUsersPerObject(Boolean allowMultipleUsersPerObject)
```
    Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
    
    Parameters:
    
    allowMultipleUsersPerObject - allowMultipleUsersPerObject or null for none
  - getAppLinkData
```
public AppLinkData getAppLinkData()
```
    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.
    
    Returns:
    
    value or null for none
  - setAppLinkData
```
public LoyaltyClass setAppLinkData(AppLinkData 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.
    
    Parameters:
    
    appLinkData - appLinkData or null for none
  - getCallbackOptions
```
public CallbackOptions getCallbackOptions()
```
    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.
    
    Returns:
    
    value or null for none
  - setCallbackOptions
```
public LoyaltyClass setCallbackOptions(CallbackOptions 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.
    
    Parameters:
    
    callbackOptions - callbackOptions or null for none
  - getClassTemplateInfo
```
public ClassTemplateInfo getClassTemplateInfo()
```
    Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
    
    Returns:
    
    value or null for none
  - setClassTemplateInfo
```
public LoyaltyClass setClassTemplateInfo(ClassTemplateInfo classTemplateInfo)
```
    Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
    
    Parameters:
    
    classTemplateInfo - classTemplateInfo or null for none
  - getCountryCode
```
public String getCountryCode()
```
    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.
    
    Returns:
    
    value or null for none
  - setCountryCode
```
public LoyaltyClass setCountryCode(String 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.
    
    Parameters:
    
    countryCode - countryCode or null for none
  - getDiscoverableProgram
```
public DiscoverableProgram getDiscoverableProgram()
```
    Information about how the class may be discovered and instantiated from within the Google Pay app.
    
    Returns:
    
    value or null for none
  - setDiscoverableProgram
```
public LoyaltyClass setDiscoverableProgram(DiscoverableProgram discoverableProgram)
```
    Information about how the class may be discovered and instantiated from within the Google Pay app.
    
    Parameters:
    
    discoverableProgram - discoverableProgram or null for none
  - getEnableSmartTap
```
public Boolean getEnableSmartTap()
```
    Identifies whether this class supports Smart Tap. The `redemptionIssuers` and one of object level `smartTapRedemptionLevel`, barcode.value`, or `accountId` fields must also be set up correctly in order for a pass to support Smart Tap.
    
    Returns:
    
    value or null for none
  - setEnableSmartTap
```
public LoyaltyClass setEnableSmartTap(Boolean enableSmartTap)
```
    Identifies whether this class supports Smart Tap. The `redemptionIssuers` and one of object level `smartTapRedemptionLevel`, barcode.value`, or `accountId` fields must also be set up correctly in order for a pass to support Smart Tap.
    
    Parameters:
    
    enableSmartTap - enableSmartTap or null for none
  - getHeroImage
```
public Image getHeroImage()
```
    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.
    
    Returns:
    
    value or null for none
  - setHeroImage
```
public LoyaltyClass setHeroImage(Image 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.
    
    Parameters:
    
    heroImage - heroImage or null for none
  - getHexBackgroundColor
```
public String getHexBackgroundColor()
```
    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`.
    
    Returns:
    
    value or null for none
  - setHexBackgroundColor
```
public LoyaltyClass setHexBackgroundColor(String 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`.
    
    Parameters:
    
    hexBackgroundColor - hexBackgroundColor or null for none
  - getHomepageUri
```
public Uri getHomepageUri()
```
    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).
    
    Returns:
    
    value or null for none
  - setHomepageUri
```
public LoyaltyClass setHomepageUri(Uri 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).
    
    Parameters:
    
    homepageUri - homepageUri or null for none
  - getId
```
public String getId()
```
    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 '-'.
    
    Returns:
    
    value or null for none
  - setId
```
public LoyaltyClass setId(String 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 '-'.
    
    Parameters:
    
    id - id or null for none
  - getImageModulesData
```
public List<ImageModuleData> getImageModulesData()
```
    Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
    
    Returns:
    
    value or null for none
  - setImageModulesData
```
public LoyaltyClass setImageModulesData(List<ImageModuleData> imageModulesData)
```
    Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
    
    Parameters:
    
    imageModulesData - imageModulesData or null for none
  - getInfoModuleData
```
public InfoModuleData getInfoModuleData()
```
    Deprecated. Use textModulesData instead.
    
    Returns:
    
    value or null for none
  - setInfoModuleData
```
public LoyaltyClass setInfoModuleData(InfoModuleData infoModuleData)
```
    Deprecated. Use textModulesData instead.
    
    Parameters:
    
    infoModuleData - infoModuleData or null for none
  - getIssuerName
```
public String getIssuerName()
```
    Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
    
    Returns:
    
    value or null for none
  - setIssuerName
```
public LoyaltyClass setIssuerName(String issuerName)
```
    Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
    
    Parameters:
    
    issuerName - issuerName or null for none
  - getKind
```
public String getKind()
```
    Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`.
    
    Returns:
    
    value or null for none
  - setKind
```
public LoyaltyClass setKind(String kind)
```
    Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`.
    
    Parameters:
    
    kind - kind or null for none
  - getLinksModuleData
```
public LinksModuleData getLinksModuleData()
```
    Links module data. If links module data is also defined on the object, both will be displayed.
    
    Returns:
    
    value or null for none
  - setLinksModuleData
```
public LoyaltyClass setLinksModuleData(LinksModuleData linksModuleData)
```
    Links module data. If links module data is also defined on the object, both will be displayed.
    
    Parameters:
    
    linksModuleData - linksModuleData or null for none
  - getLocalizedAccountIdLabel
```
public LocalizedString getLocalizedAccountIdLabel()
```
    Translated strings for the account_id_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
    
    Returns:
    
    value or null for none
  - setLocalizedAccountIdLabel
```
public LoyaltyClass setLocalizedAccountIdLabel(LocalizedString localizedAccountIdLabel)
```
    Translated strings for the account_id_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
    
    Parameters:
    
    localizedAccountIdLabel - localizedAccountIdLabel or null for none
  - getLocalizedAccountNameLabel
```
public LocalizedString getLocalizedAccountNameLabel()
```
    Translated strings for the account_name_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
    
    Returns:
    
    value or null for none
  - setLocalizedAccountNameLabel
```
public LoyaltyClass setLocalizedAccountNameLabel(LocalizedString localizedAccountNameLabel)
```
    Translated strings for the account_name_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
    
    Parameters:
    
    localizedAccountNameLabel - localizedAccountNameLabel or null for none
  - getLocalizedIssuerName
```
public LocalizedString getLocalizedIssuerName()
```
    Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
    
    Returns:
    
    value or null for none
  - setLocalizedIssuerName
```
public LoyaltyClass setLocalizedIssuerName(LocalizedString localizedIssuerName)
```
    Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
    
    Parameters:
    
    localizedIssuerName - localizedIssuerName or null for none
  - getLocalizedProgramName
```
public LocalizedString getLocalizedProgramName()
```
    Translated strings for the program_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
    
    Returns:
    
    value or null for none
  - setLocalizedProgramName
```
public LoyaltyClass setLocalizedProgramName(LocalizedString localizedProgramName)
```
    Translated strings for the program_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
    
    Parameters:
    
    localizedProgramName - localizedProgramName or null for none
  - getLocalizedRewardsTier
```
public LocalizedString getLocalizedRewardsTier()
```
    Translated strings for the rewards_tier. Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
    
    Returns:
    
    value or null for none
  - setLocalizedRewardsTier
```
public LoyaltyClass setLocalizedRewardsTier(LocalizedString localizedRewardsTier)
```
    Translated strings for the rewards_tier. Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
    
    Parameters:
    
    localizedRewardsTier - localizedRewardsTier or null for none
  - getLocalizedRewardsTierLabel
```
public LocalizedString getLocalizedRewardsTierLabel()
```
    Translated strings for the rewards_tier_label. Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
    
    Returns:
    
    value or null for none
  - setLocalizedRewardsTierLabel
```
public LoyaltyClass setLocalizedRewardsTierLabel(LocalizedString localizedRewardsTierLabel)
```
    Translated strings for the rewards_tier_label. Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
    
    Parameters:
    
    localizedRewardsTierLabel - localizedRewardsTierLabel or null for none
  - getLocalizedSecondaryRewardsTier
```
public LocalizedString getLocalizedSecondaryRewardsTier()
```
    Translated strings for the secondary_rewards_tier.
    
    Returns:
    
    value or null for none
  - setLocalizedSecondaryRewardsTier
```
public LoyaltyClass setLocalizedSecondaryRewardsTier(LocalizedString localizedSecondaryRewardsTier)
```
    Translated strings for the secondary_rewards_tier.
    
    Parameters:
    
    localizedSecondaryRewardsTier - localizedSecondaryRewardsTier or null for none
  - getLocalizedSecondaryRewardsTierLabel
```
public LocalizedString getLocalizedSecondaryRewardsTierLabel()
```
    Translated strings for the secondary_rewards_tier_label.
    
    Returns:
    
    value or null for none
  - setLocalizedSecondaryRewardsTierLabel
```
public LoyaltyClass setLocalizedSecondaryRewardsTierLabel(LocalizedString localizedSecondaryRewardsTierLabel)
```
    Translated strings for the secondary_rewards_tier_label.
    
    Parameters:
    
    localizedSecondaryRewardsTierLabel - localizedSecondaryRewardsTierLabel or null for none
  - getLocations
```
public List<LatLongPoint> getLocations()
```
    Note: This field is currently not supported to trigger geo notifications.
    
    Returns:
    
    value or null for none
  - setLocations
```
public LoyaltyClass setLocations(List<LatLongPoint> locations)
```
    Note: This field is currently not supported to trigger geo notifications.
    
    Parameters:
    
    locations - locations or null for none
  - getMerchantLocations
```
public List<MerchantLocation> getMerchantLocations()
```
    Merchant locations. There is a maximum of ten on the class. Any additional MerchantLocations added beyond the 10 will be rejected. These locations will trigger a notification when a user enters within a Google-set radius of the point. This field replaces the deprecated LatLongPoints.
    
    Returns:
    
    value or null for none
  - setMerchantLocations
```
public LoyaltyClass setMerchantLocations(List<MerchantLocation> merchantLocations)
```
    Merchant locations. There is a maximum of ten on the class. Any additional MerchantLocations added beyond the 10 will be rejected. These locations will trigger a notification when a user enters within a Google-set radius of the point. This field replaces the deprecated LatLongPoints.
    
    Parameters:
    
    merchantLocations - merchantLocations or null for none
  - getMessages
```
public List<Message> getMessages()
```
    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.
    
    Returns:
    
    value or null for none
  - setMessages
```
public LoyaltyClass setMessages(List<Message> 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.
    
    Parameters:
    
    messages - messages or null for none
  - getMultipleDevicesAndHoldersAllowedStatus
```
public String getMultipleDevicesAndHoldersAllowedStatus()
```
    Identifies whether multiple users and devices will save the same object referencing this class.
    
    Returns:
    
    value or null for none
  - setMultipleDevicesAndHoldersAllowedStatus
```
public LoyaltyClass setMultipleDevicesAndHoldersAllowedStatus(String multipleDevicesAndHoldersAllowedStatus)
```
    Identifies whether multiple users and devices will save the same object referencing this class.
    
    Parameters:
    
    multipleDevicesAndHoldersAllowedStatus - multipleDevicesAndHoldersAllowedStatus or null for none
  - getNotifyPreference
```
public String getNotifyPreference()
```
    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.
    
    Returns:
    
    value or null for none
  - setNotifyPreference
```
public LoyaltyClass setNotifyPreference(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.
    
    Parameters:
    
    notifyPreference - notifyPreference or null for none
  - getProgramLogo
```
public Image getProgramLogo()
```
    Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app.
    
    Returns:
    
    value or null for none
  - setProgramLogo
```
public LoyaltyClass setProgramLogo(Image programLogo)
```
    Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app.
    
    Parameters:
    
    programLogo - programLogo or null for none
  - getProgramName
```
public String getProgramName()
```
    Required. The program name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
    
    Returns:
    
    value or null for none
  - setProgramName
```
public LoyaltyClass setProgramName(String programName)
```
    Required. The program name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
    
    Parameters:
    
    programName - programName or null for none
  - getRedemptionIssuers
```
public List<Long> getRedemptionIssuers()
```
    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 one of object level `smartTapRedemptionValue`, barcode.value`, or `accountId` fields must also be set up correctly in order for a pass to support Smart Tap.
    
    Returns:
    
    value or null for none
  - setRedemptionIssuers
```
public LoyaltyClass setRedemptionIssuers(List<Long> 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 one of object level `smartTapRedemptionValue`, barcode.value`, or `accountId` fields must also be set up correctly in order for a pass to support Smart Tap.
    
    Parameters:
    
    redemptionIssuers - redemptionIssuers or null for none
  - getReview
```
public Review getReview()
```
    The review comments set by the platform when a class is marked `approved` or `rejected`.
    
    Returns:
    
    value or null for none
  - setReview
```
public LoyaltyClass setReview(Review review)
```
    The review comments set by the platform when a class is marked `approved` or `rejected`.
    
    Parameters:
    
    review - review or null for none
  - getReviewStatus
```
public String getReviewStatus()
```
    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`.
    
    Returns:
    
    value or null for none
  - setReviewStatus
```
public LoyaltyClass setReviewStatus(String 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`.
    
    Parameters:
    
    reviewStatus - reviewStatus or null for none
  - getRewardsTier
```
public String getRewardsTier()
```
    The rewards tier, such as "Gold" or "Platinum." Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
    
    Returns:
    
    value or null for none
  - setRewardsTier
```
public LoyaltyClass setRewardsTier(String rewardsTier)
```
    The rewards tier, such as "Gold" or "Platinum." Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
    
    Parameters:
    
    rewardsTier - rewardsTier or null for none
  - getRewardsTierLabel
```
public String getRewardsTierLabel()
```
    The rewards tier label, such as "Rewards Tier." Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
    
    Returns:
    
    value or null for none
  - setRewardsTierLabel
```
public LoyaltyClass setRewardsTierLabel(String rewardsTierLabel)
```
    The rewards tier label, such as "Rewards Tier." Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
    
    Parameters:
    
    rewardsTierLabel - rewardsTierLabel or null for none
  - getSecondaryRewardsTier
```
public String getSecondaryRewardsTier()
```
    The secondary rewards tier, such as "Gold" or "Platinum."
    
    Returns:
    
    value or null for none
  - setSecondaryRewardsTier
```
public LoyaltyClass setSecondaryRewardsTier(String secondaryRewardsTier)
```
    The secondary rewards tier, such as "Gold" or "Platinum."
    
    Parameters:
    
    secondaryRewardsTier - secondaryRewardsTier or null for none
  - getSecondaryRewardsTierLabel
```
public String getSecondaryRewardsTierLabel()
```
    The secondary rewards tier label, such as "Rewards Tier."
    
    Returns:
    
    value or null for none
  - setSecondaryRewardsTierLabel
```
public LoyaltyClass setSecondaryRewardsTierLabel(String secondaryRewardsTierLabel)
```
    The secondary rewards tier label, such as "Rewards Tier."
    
    Parameters:
    
    secondaryRewardsTierLabel - secondaryRewardsTierLabel or null for none
  - getSecurityAnimation
```
public SecurityAnimation getSecurityAnimation()
```
    Optional information about the security animation. If this is set a security animation will be rendered on pass details.
    
    Returns:
    
    value or null for none
  - setSecurityAnimation
```
public LoyaltyClass setSecurityAnimation(SecurityAnimation securityAnimation)
```
    Optional information about the security animation. If this is set a security animation will be rendered on pass details.
    
    Parameters:
    
    securityAnimation - securityAnimation or null for none
  - getTextModulesData
```
public List<TextModuleData> getTextModulesData()
```
    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.
    
    Returns:
    
    value or null for none
  - setTextModulesData
```
public LoyaltyClass setTextModulesData(List<TextModuleData> 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.
    
    Parameters:
    
    textModulesData - textModulesData or null for none
  - getValueAddedModuleData
```
public List<ValueAddedModuleData> getValueAddedModuleData()
```
    Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
    
    Returns:
    
    value or null for none
  - setValueAddedModuleData
```
public LoyaltyClass setValueAddedModuleData(List<ValueAddedModuleData> 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.
    
    Parameters:
    
    valueAddedModuleData - valueAddedModuleData or null for none
  - getVersion
```
public Long getVersion()
```
    Deprecated
    
    Returns:
    
    value or null for none
  - setVersion
```
public LoyaltyClass setVersion(Long version)
```
    Deprecated
    
    Parameters:
    
    version - version or null for none
  - getViewUnlockRequirement
```
public String getViewUnlockRequirement()
```
    View Unlock Requirement options for the loyalty card.
    
    Returns:
    
    value or null for none
  - setViewUnlockRequirement
```
public LoyaltyClass setViewUnlockRequirement(String viewUnlockRequirement)
```
    View Unlock Requirement options for the loyalty card.
    
    Parameters:
    
    viewUnlockRequirement - viewUnlockRequirement or null for none
  - getWideProgramLogo
```
public Image getWideProgramLogo()
```
    The wide logo of the loyalty program or company. When provided, this will be used in place of the program logo in the top left of the card view.
    
    Returns:
    
    value or null for none
  - setWideProgramLogo
```
public LoyaltyClass setWideProgramLogo(Image wideProgramLogo)
```
    The wide logo of the loyalty program or company. When provided, this will be used in place of the program logo in the top left of the card view.
    
    Parameters:
    
    wideProgramLogo - wideProgramLogo or null for none
  - getWordMark
```
public Image getWordMark()
```
    Deprecated.
    
    Returns:
    
    value or null for none
  - setWordMark
```
public LoyaltyClass setWordMark(Image wordMark)
```
    Deprecated.
    
    Parameters:
    
    wordMark - wordMark or null for none
  - set
```
public LoyaltyClass set(String fieldName,
                        Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public LoyaltyClass clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class LoyaltyClass

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

LoyaltyClass

Method Detail

getAccountIdLabel

setAccountIdLabel

getAccountNameLabel

setAccountNameLabel

getAllowMultipleUsersPerObject

setAllowMultipleUsersPerObject

getAppLinkData

setAppLinkData

getCallbackOptions

setCallbackOptions

getClassTemplateInfo

setClassTemplateInfo

getCountryCode

setCountryCode

getDiscoverableProgram

setDiscoverableProgram

getEnableSmartTap

setEnableSmartTap

getHeroImage

setHeroImage

getHexBackgroundColor

setHexBackgroundColor

getHomepageUri

setHomepageUri

getId

setId

getImageModulesData

setImageModulesData

getInfoModuleData

setInfoModuleData

getIssuerName

setIssuerName

getKind

setKind

getLinksModuleData

setLinksModuleData

getLocalizedAccountIdLabel

setLocalizedAccountIdLabel

getLocalizedAccountNameLabel

setLocalizedAccountNameLabel

getLocalizedIssuerName

setLocalizedIssuerName

getLocalizedProgramName

setLocalizedProgramName

getLocalizedRewardsTier

setLocalizedRewardsTier

getLocalizedRewardsTierLabel

setLocalizedRewardsTierLabel

getLocalizedSecondaryRewardsTier

setLocalizedSecondaryRewardsTier

getLocalizedSecondaryRewardsTierLabel

setLocalizedSecondaryRewardsTierLabel

getLocations

setLocations

getMerchantLocations

setMerchantLocations

getMessages

setMessages

getMultipleDevicesAndHoldersAllowedStatus

setMultipleDevicesAndHoldersAllowedStatus

getNotifyPreference

setNotifyPreference

getProgramLogo

setProgramLogo

getProgramName