Class Mage_XmlConnect_Model_Queue

Description

Magento

NOTICE OF LICENSE

This source file is subject to the Open Software License (OSL 3.0) that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://opensource.org/licenses/osl-3.0.php If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@magentocommerce.com so we can send you a copy immediately.

DISCLAIMER

Do not edit or add to this file if you wish to upgrade Magento to newer versions in the future. If you wish to customize Magento for your needs please refer to http://www.magentocommerce.com for more information.

Located in /XmlConnect/Model/Queue.php (line 27)

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_Core_Model_Template
         |
         --Mage_XmlConnect_Model_Queue
Class Constant Summary
MESSAGE_TYPE_AIRMAIL = 'airmail'
XML_PATH_CRON_MESSAGES_COUNT = 'xmlconnect/mobile_application/cron_send_messages_count'
XML_PATH_NOTIFICATION_TYPE = 'xmlconnect/devices/%s/notification_type'
Variable Summary
null|string $_appType
Method Summary
string getApplicationType ()
string getAppName ()
string getProcessedTemplate ([ $variables = array()], [bool $usePreprocess = false])
string getTplName ()
int getType ()
Mage_Core_Model_Abstract load (integer $id, [ $field = null])
void _construct ()
Variables
Methods
getAirmailBroadcastParams (line 233)

Get JSON-encoded params for broadcast AirMail

Format of JSON data: { "push": { "aps": { "alert": "New message!" } }, "title": "Message title", "message": "Your full message here.", "extra": { "some_key": "some_value" } }

  • access: public
string getAirmailBroadcastParams ()
getApplicationType (line 135)

Getter for application type

  • access: public
string getApplicationType ()
getAppName (line 150)

Getter for application name

  • access: public
string getAppName ()
getProcessedTemplate (line 172)

Retrieve processed template

  • access: public
string getProcessedTemplate ([ $variables = array()], [bool $usePreprocess = false])
  • array $variables
  • bool $usePreprocess
getPushBroadcastParams (line 266)

Get JSON-encoded params for broadcast Push Notification

Format of JSON data: { "aps": { "badge": 15, "alert": "Hello from Urban Airship!", "sound": "cat.caf" }, "exclude_tokens": [ "device token you want to skip", "another device token you want to skip" ] }

  • access: public
string getPushBroadcastParams ()
getTplName (line 160)

Getter for template name

  • access: public
string getTplName ()
getType (line 126)

Get template type

  • access: public
int getType ()

Redefinition of:
Mage_Core_Model_Template::getType()
Getter for template type
load (line 109)

Load object data

  • access: public
Mage_Core_Model_Abstract load (integer $id, [ $field = null])
  • integer $id
  • $field

Redefinition of:
Mage_Core_Model_Abstract::load()
Load object data
reset (line 206)

Reset all model data

  • access: public
save (line 285)

Save object data

  • access: public

Redefinition of:
Mage_Core_Model_Abstract::save()
Save object data
_construct (line 98)

Initialize queue message

  • access: protected
void _construct ()

Inherited Methods

Inherited From Mage_Core_Model_Template

Mage_Core_Model_Template::emulateDesign()
Mage_Core_Model_Template::getDesignConfig()
Mage_Core_Model_Template::getType()
Mage_Core_Model_Template::isPlain()
Mage_Core_Model_Template::revertDesign()
Mage_Core_Model_Template::setDesignConfig()
Mage_Core_Model_Template::_applyDesignConfig()
Mage_Core_Model_Template::_cancelDesignConfig()

Inherited From Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::afterCommitCallback()
Mage_Core_Model_Abstract::afterLoad()
Mage_Core_Model_Abstract::cleanModelCache()
Mage_Core_Model_Abstract::clearInstance()
Mage_Core_Model_Abstract::delete()
Mage_Core_Model_Abstract::getCacheIdTags()
Mage_Core_Model_Abstract::getCacheTags()
Mage_Core_Model_Abstract::getCollection()
Mage_Core_Model_Abstract::getEntityId()
Mage_Core_Model_Abstract::getId()
Mage_Core_Model_Abstract::getIdFieldName()
Mage_Core_Model_Abstract::getResource()
Mage_Core_Model_Abstract::getResourceCollection()
Mage_Core_Model_Abstract::getResourceName()
Mage_Core_Model_Abstract::isObjectNew()
Mage_Core_Model_Abstract::load()
Mage_Core_Model_Abstract::save()
Mage_Core_Model_Abstract::setId()
Mage_Core_Model_Abstract::_afterDelete()
Mage_Core_Model_Abstract::_afterDeleteCommit()
Mage_Core_Model_Abstract::_afterLoad()
Mage_Core_Model_Abstract::_afterSave()
Mage_Core_Model_Abstract::_afterSaveCommit()
Mage_Core_Model_Abstract::_beforeDelete()
Mage_Core_Model_Abstract::_beforeLoad()
Mage_Core_Model_Abstract::_beforeSave()
Mage_Core_Model_Abstract::_clearData()
Mage_Core_Model_Abstract::_clearReferences()
Mage_Core_Model_Abstract::_getEventData()
Mage_Core_Model_Abstract::_getResource()
Mage_Core_Model_Abstract::_hasModelChanged()
Mage_Core_Model_Abstract::_init()
Mage_Core_Model_Abstract::_protectFromNonAdmin()
Mage_Core_Model_Abstract::_setResourceModel()
Class Constants
MESSAGE_TYPE_AIRMAIL = 'airmail' (line 62)

Airmail message type

MESSAGE_TYPE_PUSH = 'push' (line 69)

Push notification message type

STATUS_CANCELED = 1 (line 41)

Status cenceled identifier

STATUS_COMPLETED = 2 (line 48)

Status completed identifier

STATUS_DELETED = 3 (line 55)

Status deleted identifier

STATUS_IN_QUEUE = 0 (line 34)

Status in queue identifier

XML_PATH_CRON_MESSAGES_COUNT = 'xmlconnect/mobile_application/cron_send_messages_count' (line 84)

Count of message in queue for cron config path

XML_PATH_NOTIFICATION_TYPE = 'xmlconnect/devices/%s/notification_type' (line 76)

Notification type config path

Inherited Constants

Inherited from Mage_Core_Model_Template

Mage_Core_Model_Template::DEFAULT_DESIGN_AREA
Mage_Core_Model_Template::TYPE_HTML
Mage_Core_Model_Template::TYPE_TEXT

Documentation generated on Fri, 11 Feb 2011 17:10:45 +0200 by phpDocumentor 1.4.3