File "GenericClass.php"
Full Path: /home/palsarh/web/palsarh.in/public_html/vendor/google/apiclient-services/src/Walletobjects/GenericClass.php
File size: 13.27 KB
MIME-type: text/x-php
Charset: utf-8
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Walletobjects;
class GenericClass extends \Google\Collection
{
/**
* Unspecified preference.
*/
public const MULTIPLE_DEVICES_AND_HOLDERS_ALLOWED_STATUS_STATUS_UNSPECIFIED = 'STATUS_UNSPECIFIED';
/**
* The Pass object is shareable by a user and can be saved by any number of
* different users, and on any number of devices. Partners typically use this
* setup for passes that do not need to be restricted to a single user or
* pinned to a single device.
*/
public const MULTIPLE_DEVICES_AND_HOLDERS_ALLOWED_STATUS_MULTIPLE_HOLDERS = 'MULTIPLE_HOLDERS';
/**
* An object can only be saved by one user, but this user can view and use it
* on multiple of their devices. Once the first user saves the object, no
* other user will be allowed to view or save it.
*/
public const MULTIPLE_DEVICES_AND_HOLDERS_ALLOWED_STATUS_ONE_USER_ALL_DEVICES = 'ONE_USER_ALL_DEVICES';
/**
* An object can only be saved by one user on a single device. Intended for
* use by select partners in limited circumstances. An example use case is a
* transit ticket that should be "device pinned", meaning it can be saved,
* viewed and used only by a single user on a single device. Contact support
* for additional information.
*/
public const MULTIPLE_DEVICES_AND_HOLDERS_ALLOWED_STATUS_ONE_USER_ONE_DEVICE = 'ONE_USER_ONE_DEVICE';
/**
* Legacy alias for `MULTIPLE_HOLDERS`. Deprecated.
*
* @deprecated
*/
public const MULTIPLE_DEVICES_AND_HOLDERS_ALLOWED_STATUS_multipleHolders = 'multipleHolders';
/**
* Legacy alias for `ONE_USER_ALL_DEVICES`. Deprecated.
*
* @deprecated
*/
public const MULTIPLE_DEVICES_AND_HOLDERS_ALLOWED_STATUS_oneUserAllDevices = 'oneUserAllDevices';
/**
* Legacy alias for `ONE_USER_ONE_DEVICE`. Deprecated.
*
* @deprecated
*/
public const MULTIPLE_DEVICES_AND_HOLDERS_ALLOWED_STATUS_oneUserOneDevice = 'oneUserOneDevice';
/**
* Default value, same as UNLOCK_NOT_REQUIRED.
*/
public const VIEW_UNLOCK_REQUIREMENT_VIEW_UNLOCK_REQUIREMENT_UNSPECIFIED = 'VIEW_UNLOCK_REQUIREMENT_UNSPECIFIED';
/**
* Default behavior for all the existing Passes if ViewUnlockRequirement is
* not set.
*/
public const VIEW_UNLOCK_REQUIREMENT_UNLOCK_NOT_REQUIRED = 'UNLOCK_NOT_REQUIRED';
/**
* Requires the user to unlock their device each time the pass is viewed. If
* the user removes their device lock after saving the pass, then they will be
* prompted to create a device lock before the pass can be viewed.
*/
public const VIEW_UNLOCK_REQUIREMENT_UNLOCK_REQUIRED_TO_VIEW = 'UNLOCK_REQUIRED_TO_VIEW';
protected $collection_key = 'valueAddedModuleData';
protected $appLinkDataType = AppLinkData::class;
protected $appLinkDataDataType = '';
protected $callbackOptionsType = CallbackOptions::class;
protected $callbackOptionsDataType = '';
protected $classTemplateInfoType = ClassTemplateInfo::class;
protected $classTemplateInfoDataType = '';
/**
* Available only to Smart Tap enabled partners. Contact support for
* additional guidance.
*
* @var bool
*/
public $enableSmartTap;
/**
* 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 `-`.
*
* @var string
*/
public $id;
protected $imageModulesDataType = ImageModuleData::class;
protected $imageModulesDataDataType = 'array';
protected $linksModuleDataType = LinksModuleData::class;
protected $linksModuleDataDataType = '';
protected $merchantLocationsType = MerchantLocation::class;
protected $merchantLocationsDataType = 'array';
protected $messagesType = Message::class;
protected $messagesDataType = 'array';
/**
* Identifies whether multiple users and devices will save the same object
* referencing this class.
*
* @var string
*/
public $multipleDevicesAndHoldersAllowedStatus;
/**
* 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.
*
* @var string[]
*/
public $redemptionIssuers;
protected $securityAnimationType = SecurityAnimation::class;
protected $securityAnimationDataType = '';
protected $textModulesDataType = TextModuleData::class;
protected $textModulesDataDataType = 'array';
protected $valueAddedModuleDataType = ValueAddedModuleData::class;
protected $valueAddedModuleDataDataType = 'array';
/**
* View Unlock Requirement options for the generic pass.
*
* @var string
*/
public $viewUnlockRequirement;
/**
* 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.
*
* @param AppLinkData $appLinkData
*/
public function setAppLinkData(AppLinkData $appLinkData)
{
$this->appLinkData = $appLinkData;
}
/**
* @return AppLinkData
*/
public function getAppLinkData()
{
return $this->appLinkData;
}
/**
* 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.
*
* @param CallbackOptions $callbackOptions
*/
public function setCallbackOptions(CallbackOptions $callbackOptions)
{
$this->callbackOptions = $callbackOptions;
}
/**
* @return CallbackOptions
*/
public function getCallbackOptions()
{
return $this->callbackOptions;
}
/**
* Template information about how the class should be displayed. If unset,
* Google will fallback to a default set of fields to display.
*
* @param ClassTemplateInfo $classTemplateInfo
*/
public function setClassTemplateInfo(ClassTemplateInfo $classTemplateInfo)
{
$this->classTemplateInfo = $classTemplateInfo;
}
/**
* @return ClassTemplateInfo
*/
public function getClassTemplateInfo()
{
return $this->classTemplateInfo;
}
/**
* Available only to Smart Tap enabled partners. Contact support for
* additional guidance.
*
* @param bool $enableSmartTap
*/
public function setEnableSmartTap($enableSmartTap)
{
$this->enableSmartTap = $enableSmartTap;
}
/**
* @return bool
*/
public function getEnableSmartTap()
{
return $this->enableSmartTap;
}
/**
* 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 `-`.
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
/**
* 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.
*
* @param ImageModuleData[] $imageModulesData
*/
public function setImageModulesData($imageModulesData)
{
$this->imageModulesData = $imageModulesData;
}
/**
* @return ImageModuleData[]
*/
public function getImageModulesData()
{
return $this->imageModulesData;
}
/**
* 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.
*
* @param LinksModuleData $linksModuleData
*/
public function setLinksModuleData(LinksModuleData $linksModuleData)
{
$this->linksModuleData = $linksModuleData;
}
/**
* @return LinksModuleData
*/
public function getLinksModuleData()
{
return $this->linksModuleData;
}
/**
* 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.
*
* @param MerchantLocation[] $merchantLocations
*/
public function setMerchantLocations($merchantLocations)
{
$this->merchantLocations = $merchantLocations;
}
/**
* @return MerchantLocation[]
*/
public function getMerchantLocations()
{
return $this->merchantLocations;
}
/**
* 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.
*
* @param Message[] $messages
*/
public function setMessages($messages)
{
$this->messages = $messages;
}
/**
* @return Message[]
*/
public function getMessages()
{
return $this->messages;
}
/**
* Identifies whether multiple users and devices will save the same object
* referencing this class.
*
* Accepted values: STATUS_UNSPECIFIED, MULTIPLE_HOLDERS,
* ONE_USER_ALL_DEVICES, ONE_USER_ONE_DEVICE, multipleHolders,
* oneUserAllDevices, oneUserOneDevice
*
* @param self::MULTIPLE_DEVICES_AND_HOLDERS_ALLOWED_STATUS_* $multipleDevicesAndHoldersAllowedStatus
*/
public function setMultipleDevicesAndHoldersAllowedStatus($multipleDevicesAndHoldersAllowedStatus)
{
$this->multipleDevicesAndHoldersAllowedStatus = $multipleDevicesAndHoldersAllowedStatus;
}
/**
* @return self::MULTIPLE_DEVICES_AND_HOLDERS_ALLOWED_STATUS_*
*/
public function getMultipleDevicesAndHoldersAllowedStatus()
{
return $this->multipleDevicesAndHoldersAllowedStatus;
}
/**
* 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.
*
* @param string[] $redemptionIssuers
*/
public function setRedemptionIssuers($redemptionIssuers)
{
$this->redemptionIssuers = $redemptionIssuers;
}
/**
* @return string[]
*/
public function getRedemptionIssuers()
{
return $this->redemptionIssuers;
}
/**
* Optional information about the security animation. If this is set a
* security animation will be rendered on pass details.
*
* @param SecurityAnimation $securityAnimation
*/
public function setSecurityAnimation(SecurityAnimation $securityAnimation)
{
$this->securityAnimation = $securityAnimation;
}
/**
* @return SecurityAnimation
*/
public function getSecurityAnimation()
{
return $this->securityAnimation;
}
/**
* 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.
*
* @param TextModuleData[] $textModulesData
*/
public function setTextModulesData($textModulesData)
{
$this->textModulesData = $textModulesData;
}
/**
* @return TextModuleData[]
*/
public function getTextModulesData()
{
return $this->textModulesData;
}
/**
* Optional value added module data. Maximum of ten on the class. For a pass
* only ten will be displayed, prioritizing those from the object.
*
* @param ValueAddedModuleData[] $valueAddedModuleData
*/
public function setValueAddedModuleData($valueAddedModuleData)
{
$this->valueAddedModuleData = $valueAddedModuleData;
}
/**
* @return ValueAddedModuleData[]
*/
public function getValueAddedModuleData()
{
return $this->valueAddedModuleData;
}
/**
* View Unlock Requirement options for the generic pass.
*
* Accepted values: VIEW_UNLOCK_REQUIREMENT_UNSPECIFIED, UNLOCK_NOT_REQUIRED,
* UNLOCK_REQUIRED_TO_VIEW
*
* @param self::VIEW_UNLOCK_REQUIREMENT_* $viewUnlockRequirement
*/
public function setViewUnlockRequirement($viewUnlockRequirement)
{
$this->viewUnlockRequirement = $viewUnlockRequirement;
}
/**
* @return self::VIEW_UNLOCK_REQUIREMENT_*
*/
public function getViewUnlockRequirement()
{
return $this->viewUnlockRequirement;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GenericClass::class, 'Google_Service_Walletobjects_GenericClass');