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_Message

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

Class Overview




Alert message entity that can be used 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 72]

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









[ Top ]







Class Variables



	
	

	
$badge =  null

	
[line 98]

  The badge to assign to the app


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      string|null
    

      

	



	
[ Top ]


	
	

	
$body =  null

	
[line 80]

  The alert body


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      string|Services_Apns_Alert|null
    

      

	



	
[ Top ]


	
	

	
$customArgs = array()

	
[line 104]

  An array contains custom arguments to add to the message


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$deviceToken =  null

	
[line 86]

  The device token


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      string|null
    

      

	



	
[ Top ]


	
	

	
$expirationDate =  null

	
[line 92]

  The message expiration date


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$soundFile =  null

	
[line 110]

  A sound file to fire when the alert received


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      string|null
    

      

	



	
[ Top ]










Method Detail



	
	
getBadge   [line 230]

	

    

    

		string|null getBadge(
)
    

    


	
		Gets the badge


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getBody   [line 173]

	

    

    

		string|null getBody(
)
    

    


	
		Gets the alert body


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getCustomArgs   [line 259]

	

    

    

		array getCustomArgs(
)
    

    


	
		Gets the message custom args


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getDeviceToken   [line 140]

	

    

    

		string|null getDeviceToken(
)
    

    


	
		Gets the device token


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getExpirationDate   [line 201]

	

    

    

		int|null getExpirationDate(
)
    

    


	
		Gets the launch image


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getPayload   [line 303]

	

    

    

		array getPayload(
)
    

    


	
		Gets the payload as array


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getPayloadAsJson   [line 368]

	

    

    

		string getPayloadAsJson(
)
    

    


	
		Get the payload array as a compressed json string


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getSoundFile   [line 289]

	

    

    

		string|null getSoundFile(
)
    

    


	
		Gets the sound file


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
setBadge   [line 214]

	

    

    

		Services_Apns_Alert setBadge(
string|null
$value)
    

    


	
		Set the badge that'll be assigned to the app


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string|null  
        $value  
        — 
        The value to assign
      

        

    


        
[ Top ]

  

  
  
	
	
setBody   [line 152]

	

    

    

		Services_Apns_Alert setBody(
string|Services_Apns_Alert|null
$value)
    

    


	
		Set the alert body


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string|Services_Apns_Alert|null  
        $value  
        — 
        The value to assign
      

        

    


        
[ Top ]

  

  
  
	
	
setCustomArgs   [line 242]

	

    

    

		Services_Apns_Alert setCustomArgs(
array
$args)
    

    


	
		Set custom arguments to be forwarded to your app


    

  • Access: public
    • 








        
Parameters:

    

    

          

        array|null  
        $args  
        — 
        The value to assign
      

        

    


        
[ Top ]

  

  
  
	
	
setDeviceToken   [line 124]

	

    

    

		Services_Apns_Alert setDeviceToken(
string|null
$value)
    

    


	
		Set the device token you wish to query  (the token received from the APNS registeration method in iOS SDK)


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string|null  
        $value  
        — 
        The value to assign
      

        

    


        
[ Top ]

  

  
  
	
	
setExpirationDate   [line 185]

	

    

    

		Services_Apns_Alert setExpirationDate(
int|null
$value)
    

    


	
		Set the message expiration date


    

  • Access: public
    • 








        
Parameters:

    

    

          

        int|null  
        $value  
        — 
        The value to assign
      

        

    


        
[ Top ]

  

  
  
	
	
setSoundFile   [line 273]

	

    

    

		Services_Apns_Alert setSoundFile(
string|null
$value)
    

    


	
		Set the sound file (in your app folder) that will  be fired when the message received.


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string|null  
        $value  
        — 
        The value to assign
      

        

    


        
[ Top ]

  

  
  



        

		    

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