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

Element index for package Services_Apns

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ i ] [ l ] [ m ] [ p ] [ r ] [ s ] [ w ] [ _ ]

_

__construct
in file Alert.php, method Services_Apns_Alert::__construct()
    Construct a new Alert message
__destruct
in file Client.php, method Services_Apns_Client::__destruct()
    Class destructor: used to dispose the connection, in case it was opened
top

a

$actionLocalizedKey
in file Alert.php, variable Services_Apns_Alert::$actionLocalizedKey
    The action localized key
Alert.php
procedural page Alert.php
top

b

$badge
in file Message.php, variable Services_Apns_Message::$badge
    The badge to assign to the app
$body
in file Alert.php, variable Services_Apns_Alert::$body
    The alert body
$body
in file Message.php, variable Services_Apns_Message::$body
    The alert body
$bodyLocalizedArgs
in file Alert.php, variable Services_Apns_Alert::$bodyLocalizedArgs
    Additional arguments for body localization
$bodyLocalizedKey
in file Alert.php, variable Services_Apns_Alert::$bodyLocalizedKey
    The action localized key
top

c

$customArgs
in file Message.php, variable Services_Apns_Message::$customArgs
    An array contains custom arguments to add to the message
close
in file Client.php, method Services_Apns_Client::close()
    Close the connection to the APNS gateway
connect
in file Client.php, method Services_Apns_Client::connect()
    Open the connection to Apple Push Notifications service
Client.php
procedural page Client.php
top

d

$defaultEnvironment
in file Client.php, variable Services_Apns_Client::$defaultEnvironment
    The default environment
$deviceToken
in file Message.php, variable Services_Apns_Message::$deviceToken
    The device token
top

e

$expirationDate
in file Message.php, variable Services_Apns_Message::$expirationDate
    The message expiration date
ENV_PRODUCTION
in file Client.php, class constant Services_Apns_Client::ENV_PRODUCTION
    Constat used with Services_Apns_Client::connect.
ENV_SANDBOX
in file Client.php, class constant Services_Apns_Client::ENV_SANDBOX
    Constat used with Services_Apns_Client::connect.
Exception.php
procedural page Exception.php
top

f

Feedback.php
procedural page Feedback.php
top

g

getActionLocalizedKey
in file Alert.php, method Services_Apns_Alert::getActionLocalizedKey()
    Gets the action localized key
getApnsProductionUri
in file Message.php, method Services_Apns_Client_Message::getApnsProductionUri()
    (non-PHPdoc)
getApnsProductionUri
in file Client.php, method Services_Apns_Client::getApnsProductionUri()
    Get the APNS sandbox uri to query
getApnsProductionUri
in file Feedback.php, method Services_Apns_Client_Feedback::getApnsProductionUri()
    (non-PHPdoc)
getApnsSandboxUri
in file Client.php, method Services_Apns_Client::getApnsSandboxUri()
    Get the APNS sandbox uri to query
getApnsSandboxUri
in file Feedback.php, method Services_Apns_Client_Feedback::getApnsSandboxUri()
    (non-PHPdoc)
getApnsSandboxUri
in file Message.php, method Services_Apns_Client_Message::getApnsSandboxUri()
    (non-PHPdoc)
getBadge
in file Message.php, method Services_Apns_Message::getBadge()
    Gets the badge
getBody
in file Message.php, method Services_Apns_Message::getBody()
    Gets the alert body
getBody
in file Alert.php, method Services_Apns_Alert::getBody()
    Gets the alert body
getBodyLocalizationArgs
in file Alert.php, method Services_Apns_Alert::getBodyLocalizationArgs()
    Gets the body localization args
getBodyLocalizedKey
in file Alert.php, method Services_Apns_Alert::getBodyLocalizedKey()
    Gets the body localized key
getCustomArgs
in file Message.php, method Services_Apns_Message::getCustomArgs()
    Gets the message custom args
getDefaultEnvironment
in file Client.php, method Services_Apns_Client::getDefaultEnvironment()
    Gets the default environment
getDeviceToken
in file Message.php, method Services_Apns_Message::getDeviceToken()
    Gets the device token
getExpirationDate
in file Message.php, method Services_Apns_Message::getExpirationDate()
    Gets the launch image
getFeedback
in file Feedback.php, method Services_Apns_Client_Feedback::getFeedback()
    Gets the feedback query data
getLaunchImage
in file Alert.php, method Services_Apns_Alert::getLaunchImage()
    Gets the launch image
getPasswordPhrase
in file Client.php, method Services_Apns_Client::getPasswordPhrase()
    Gets the password phrase
getPayload
in file Alert.php, method Services_Apns_Alert::getPayload()
    Get the alert message data payload as array
getPayload
in file Message.php, method Services_Apns_Message::getPayload()
    Gets the payload as array
getPayloadAsJson
in file Message.php, method Services_Apns_Message::getPayloadAsJson()
    Get the payload array as a compressed json string
getSoundFile
in file Message.php, method Services_Apns_Message::getSoundFile()
    Gets the sound file
getSslCertificateFilePath
in file Client.php, method Services_Apns_Client::getSslCertificateFilePath()
    Get the file path to the authorized SSL certificate provided by Apple
top

i

$isConnected
in file Client.php, variable Services_Apns_Client::$isConnected
    Is the stream socket connected
initConnection
in file Client.php, method Services_Apns_Client::initConnection()
    Initialize the connection to the APNS gateway
isConnected
in file Client.php, method Services_Apns_Client::isConnected()
    Gets the value that indicates if the stream currently connected to the APNS gateway.
index.php
procedural page index.php
top

l

$launchImage
in file Alert.php, variable Services_Apns_Alert::$launchImage
    Path to a launch image to use
top

m

Message.php
procedural page Message.php
Message.php
procedural page Message.php
top

p

$passPhrase
in file Client.php, variable Services_Apns_Client::$passPhrase
    The password pharse
top

r

read
in file Client.php, method Services_Apns_Client::read()
    Read bytes from the APNS gateway stream
top

s

$socketHandler
in file Client.php, variable Services_Apns_Client::$socketHandler
    The stream socket handler
$soundFile
in file Message.php, variable Services_Apns_Message::$soundFile
    A sound file to fire when the alert received
$sslCertFilePath
in file Client.php, variable Services_Apns_Client::$sslCertFilePath
    The file path to the authorized SSL certificate provided by Apple
sendMessage
in file Message.php, method Services_Apns_Client_Message::sendMessage()
    Send a message to APNS gateway
Services_Apns_Alert
in file Alert.php, class Services_Apns_Alert
    Alert entity that can be used as a message body to query Apple Push Notifications Service.
Services_Apns_Client
in file Client.php, class Services_Apns_Client
    Short description for class
Services_Apns_Client_Feedback
in file Feedback.php, class Services_Apns_Client_Feedback
    Client class used to query Apple Push Notifications Service feedback gateway.
Services_Apns_Client_Message
in file Message.php, class Services_Apns_Client_Message
    Client class used to query Apple Push Notifications Service with messages.
Services_Apns_Exception
in file Exception.php, class Services_Apns_Exception
    Base exception for the Services_Apns package
Services_Apns_Message
in file Message.php, class Services_Apns_Message
    Alert message entity that can be used to query Apple Push Notifications Service.
setActionLocalizedKey
in file Alert.php, method Services_Apns_Alert::setActionLocalizedKey()
    Set the alert action localized key
setBadge
in file Message.php, method Services_Apns_Message::setBadge()
    Set the badge that'll be assigned to the app
setBody
in file Message.php, method Services_Apns_Message::setBody()
    Set the alert body
setBody
in file Alert.php, method Services_Apns_Alert::setBody()
    Set the alert body
setBodyLocalizationArgs
in file Alert.php, method Services_Apns_Alert::setBodyLocalizationArgs()
    Set the alert body localization args
setBodyLocalizedKey
in file Alert.php, method Services_Apns_Alert::setBodyLocalizedKey()
    Set the alert body localized key
setCustomArgs
in file Message.php, method Services_Apns_Message::setCustomArgs()
    Set custom arguments to be forwarded to your app
setDefaultEnvironment
in file Client.php, method Services_Apns_Client::setDefaultEnvironment()
    Set the default environment
setDeviceToken
in file Message.php, method Services_Apns_Message::setDeviceToken()
    Set the device token you wish to query (the token received from the APNS registeration method in iOS SDK)
setExpirationDate
in file Message.php, method Services_Apns_Message::setExpirationDate()
    Set the message expiration date
setLaunchImage
in file Alert.php, method Services_Apns_Alert::setLaunchImage()
    Set the alert launch image to use in case the user requested to open the App.
setPasswordPhrase
in file Client.php, method Services_Apns_Client::setPasswordPhrase()
    Set the password phrase
setSoundFile
in file Message.php, method Services_Apns_Message::setSoundFile()
    Set the sound file (in your app folder) that will be fired when the message received.
setSslCertificateFilePath
in file Client.php, method Services_Apns_Client::setSslCertificateFilePath()
    Set the file path to the authorized SSL certificate provided by Apple
SOCKET_DEFAULT_TIMEOUT
in file Client.php, class constant Services_Apns_Client::SOCKET_DEFAULT_TIMEOUT
    Specifiying the connection socket default timeout
SOCKET_READ_BYTES
in file Client.php, class constant Services_Apns_Client::SOCKET_READ_BYTES
    The number of bytes to read each time from the stream.
top

w

write
in file Client.php, method Services_Apns_Client::write()
    Writes the given data to the socket stream
top
Documentation generated on Mon, 11 Mar 2019 15:53:02 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.