Services_Apns
[ class tree: Services_Apns ] [ index: Services_Apns ] [ all elements ]
Packages:
Services_Apns


Classes:
Services_Apns_Alert
Services_Apns_Client
Services_Apns_Client_Feedback
Services_Apns_Client_Message
Services_Apns_Exception
Services_Apns_Message
Files:
Alert.php
Client.php
Exception.php
Feedback.php
index.php
Message.php
Message.php

Class: Services_Apns_Alert

Source Location: /Services_Apns-0.1.0/Services/Apns/Alert.php

Class Overview




Alert entity that can be used as a message body  to query Apple Push Notifications Service.




Author(s):






        
          
          

Version:


    
  
  • Release: 0.1.0
    • 




Copyright:


    
  
  • 2013 Yahav Gindi Bar
    • 







Variables






Methods
















Inherited Variables





Inherited Methods














Class Details



[line 71]

Alert entity that can be used as a message body  to query Apple Push Notifications Service.
An alert is a plain message. However, you can use an alert to  specify a localization key from your plist file for localization.
In addition, you can send extra arguments,  in case you've used them in the localization strings.









[ Top ]







Class Variables



	
	

	
$actionLocalizedKey =  null

	
[line 97]

  The action localized key


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      string|null
    

      

	



	
[ Top ]


	
	

	
$body =  null

	
[line 79]

  The alert body


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      string|null
    

      

	



	
[ Top ]


	
	

	
$bodyLocalizedArgs = array()

	
[line 91]

  Additional arguments for body localization


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$bodyLocalizedKey =  null

	
[line 85]

  The action localized key


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      string|null
    

      

	



	
[ Top ]


	
	

	
$launchImage =  null

	
[line 103]

  Path to a launch image to use


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      string|null
    

      

	



	
[ Top ]










Method Detail



	
	
__construct (Constructor)   [line 118]

	

    

    

		Services_Apns_Alert __construct(
string|null
$body, [string|null
$localizedBodyKey = null], [array
$bodyLocalizedArgs = array()], [string|null
$actionLocalizedKey = null], [string|null
$launchImage = null])
    

    


	
		Construct a new Alert message


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string|null  
        $body  
        — 
        The message body.
      

          

        string|null  
        $localizedBodyKey  
        — 
        The body localized key
      

          

        array  
        $bodyLocalizedArgs  
        — 
        The body localized arguments
      

          

        string|null  
        $actionLocalizedKey  
        — 
        The action localized key
      

          

        string|null  
        $launchImage  
        — 
        A launch image to display
      

        

    


        
[ Top ]

  

  
  
	
	
getActionLocalizedKey   [line 190]

	

    

    

		string|null getActionLocalizedKey(
)
    

    


	
		Gets the action localized key


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getBody   [line 161]

	

    

    

		string|null getBody(
)
    

    


	
		Gets the alert body


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getBodyLocalizationArgs   [line 281]

	

    

    

		array getBodyLocalizationArgs(
)
    

    


	
		Gets the body localization args


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getBodyLocalizedKey   [line 219]

	

    

    

		string|null getBodyLocalizedKey(
)
    

    


	
		Gets the body localized key


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getLaunchImage   [line 249]

	

    

    

		string|null getLaunchImage(
)
    

    


	
		Gets the launch image


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getPayload   [line 295]

	

    

    

		array getPayload(
)
    

    


	
		Get the alert message data payload as array


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
setActionLocalizedKey   [line 173]

	

    

    

		Services_Apns_Message_Alert setActionLocalizedKey(
string|null
$value)
    

    


	
		Set the alert action localized key


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string|null  
        $value  
        — 
        The localized action key string
      

        

    


        
[ Top ]

  

  
  
	
	
setBody   [line 144]

	

    

    

		Services_Apns_Message_Alert setBody(
string
$value)
    

    


	
		Set the alert body


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $value  
        — 
        The body value to assign
      

        

    


        
[ Top ]

  

  
  
	
	
setBodyLocalizationArgs   [line 261]

	

    

    

		Services_Apns_Message_Alert setBodyLocalizationArgs(
array
$args)
    

    


	
		Set the alert body localization args


    

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $args  
        — 
        The alert body localized message extra args
      

        

    


        
[ Top ]

  

  
  
	
	
setBodyLocalizedKey   [line 202]

	

    

    

		Services_Apns_Message_Alert setBodyLocalizedKey(
string|null
$value)
    

    


	
		Set the alert body localized key


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string|null  
        $value  
        — 
        The alert body localized key
      

        

    


        
[ Top ]

  

  
  
	
	
setLaunchImage   [line 232]

	

    

    

		Services_Apns_Message_Alert setLaunchImage(
string|null
$value)
    

    


	
		Set the alert launch image to use  in case the user requested to open the App.


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string|null  
        $value  
        — 
        The launch image file path
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Mon, 11 Mar 2019 15:53:02 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright ©  PHP Group 2004.