Index | Notificato API

A

MessageBuilder::addAlertAction() — Method in class MessageBuilder: Add custom (iOS 8+) actions to the alert you display Note: You must also call setAlert() or setAlertLocalized() to make a complete alert
MessageBuilder::addAlertActionLocalized() — Method in class MessageBuilder: Add localized custom (iOS 8+) actions to the alert you display Note: You must also call setAlert() or setAlertLocalized() to make a complete alert

B

Message::builder() — Method in class Message: Get a builder to constuct a message
MessageBuilder::build() — Method in class MessageBuilder: Build the message

C

Certificate — Class in namespace Wrep\Notificato\Apns
CertificateFactory — Class in namespace Wrep\Notificato\Apns
CertificateFactory::createCertificate() — Method in class CertificateFactory: Create a Certificate
FeedbackFactory::createFeedback() — Method in class FeedbackFactory: Create a Feedback object
GatewayFactory::createGateway() — Method in class GatewayFactory: Create a Gateway object
MessageBuilder::clearBadge() — Method in class MessageBuilder: Clear the badge from the App icon
Notificato::createCertificate() — Method in class Notificato: Create an APNS Certificate

F

Feedback — Class in namespace Wrep\Notificato\Apns\Feedback
FeedbackFactory — Class in namespace Wrep\Notificato\Apns\Feedback
Gateway::flush() — Method in class Gateway: Send all queued messages
Sender::flush() — Method in class Sender: Send all queued messages
Notificato::flush() — Method in class Notificato: Send all queued messages

G

Certificate::getPemFile() — Method in class Certificate: Get the path to the PEM file
Certificate::getPassphrase() — Method in class Certificate: Passphrase to use with the PEM file
Certificate::getEnvironment() — Method in class Certificate: Get the APNS environment this certificate is associated with
Certificate::getDescription() — Method in class Certificate: An as humanreadable as possible description of the certificate to identify the certificate
Certificate::getValidFrom() — Method in class Certificate: Get moment this certificate will become valid Note: Will return null if certificate validation was disabled
Certificate::getValidTo() — Method in class Certificate: Get moment this certificate will expire Note: Will return null if certificate validation was disabled
Certificate::getEndpoint() — Method in class Certificate: Get the endpoint this certificate is valid for
Certificate::getFingerprint() — Method in class Certificate: Get a unique hash of the certificate this can be used to check if two Apns\Certificate objects are the same
CertificateFactory::getDefaultCertificate() — Method in class CertificateFactory: Get the current default certificate
FeedbackFactory::getCertificateFactory() — Method in class FeedbackFactory: Get the current certificate factory
Tuple::getInvalidatedAt() — Method in class Tuple: Moment the device unregistered.
Tuple::getDeviceToken() — Method in class Tuple: Get the device token of the device that unregistered
Tuple::getCertificate() — Method in class Tuple: Get the certificate used while receiving this tuple
Gateway — Class in namespace Wrep\Notificato\Apns
Gateway::getQueueLength() — Method in class Gateway: Count of all queued messages
GatewayFactory — Class in namespace Wrep\Notificato\Apns
Message::getDeviceToken() — Method in class Message: Get the device token of the receiving device
Message::getCertificate() — Method in class Message: Get the certificate that should be used for this message
Message::getExpiresAt() — Method in class Message: Get the moment this message expires
Message::getAlert() — Method in class Message: Get the current alert
Message::getBadge() — Method in class Message: Get the value of the badge as set in this message
Message::getSound() — Method in class Message: Get the sound that will be played when this message is received
Message::getCategory() — Method in class Message: Get the category identifier that will be used to determine custom actions
Message::getContentAvailable() — Method in class Message: Get newsstand content availability flag that will trigger the newsstand item to download new content
Message::getPayload() — Method in class Message: Get the current payload
Message::getJson() — Method in class Message: Get the JSON payload that should be send to the APNS
MessageEnvelope::getIdentifier() — Method in class MessageEnvelope: Unique number to the relevant APNS connection to identify this message
MessageEnvelope::getMessage() — Method in class MessageEnvelope: The message that's is contained by this envelope
MessageEnvelope::getRetryEnvelope() — Method in class MessageEnvelope: Get the envelope used for the retry
MessageEnvelope::getStatus() — Method in class MessageEnvelope: Get the current status of this message envelope
MessageEnvelope::getStatusDescription() — Method in class MessageEnvelope: Get a description of the current status of this message envelope
MessageEnvelope::getFinalStatus() — Method in class MessageEnvelope: Get the final status after all retries.
MessageEnvelope::getFinalStatusDescription() — Method in class MessageEnvelope: Get a description of the final status after all retries.
MessageEnvelope::getBinaryMessage() — Method in class MessageEnvelope: Get the message that this envelope contains in binary APNS compatible format
Sender::getGatewayFactory() — Method in class Sender: Get the current gateway factory
Sender::getQueueLength() — Method in class Sender: Count of all queued messages
SslSocket::getCertificate() — Method in class SslSocket: Get the certificate used with this connection

H

Certificate::hasPassphrase() — Method in class Certificate: Checks if there is a passphrase to use with the certificate

I

Certificate::isValidated() — Method in class Certificate: Check if this certificate is validated
InvalidCertificateException — Class in namespace Wrep\Notificato\Apns\Exception
Message::isCompatibleWithSmallPayloadSize() — Method in class Message: Check if this message is short enough to be send to iOS 7 or OS X Note: iOS 8 support messages up to 2048 bytes, OS X and iOS 7 and below support messages up to 256 bytes

M

Message — Class in namespace Wrep\Notificato\Apns: An APNS Message representation.
MessageBuilder — Class in namespace Wrep\Notificato\Apns
MessageEnvelope — Class in namespace Wrep\Notificato\Apns
Notificato::messageBuilder() — Method in class Notificato: Create a Message builder

N

Notificato — Class in namespace Wrep\Notificato

Q

Gateway::queue() — Method in class Gateway: Queue a message for sending
Sender::queue() — Method in class Sender: Queue a message on the correct APNS gateway connection
Notificato::queue() — Method in class Notificato: Queue a message on the correct APNS gateway connection

R

Feedback::receive() — Method in class Feedback: Receive the feedback tuples from APNS
Notificato::receiveFeedback() — Method in class Notificato: Receive the feedback tuples from APNS

S

Certificate::serialize() — Method in class Certificate: String representation of object
CertificateFactory::setDefaultCertificate() — Method in class CertificateFactory: Set the default certificate
FeedbackFactory::setCertificateFactory() — Method in class FeedbackFactory: Set a certificate factory to fetch the default certificate from
Message::serialize() — Method in class Message: String representation of object
MessageBuilder::setDeviceToken() — Method in class MessageBuilder: Set the receiver of the message
MessageBuilder::setCertificate() — Method in class MessageBuilder: Set the certificate to use when
MessageBuilder::setExpiresAt() — Method in class MessageBuilder: Set the moment this message should expire or null if APNS should not store the message at all.
MessageBuilder::setAlert() — Method in class MessageBuilder: Set the alert to display.
MessageBuilder::setAlertLocalized() — Method in class MessageBuilder: Set the localized alert to display.
MessageBuilder::setBadge() — Method in class MessageBuilder: Set the badge to display on the App icon
MessageBuilder::setSound() — Method in class MessageBuilder: Set the sound that will be played when this message is received
MessageBuilder::setContentAvailable() — Method in class MessageBuilder: Set newsstand content availability flag that will trigger the newsstand item to download new content
MessageBuilder::setCategory() — Method in class MessageBuilder: Set the category identifier for this message used by the app to display custom actions
MessageBuilder::setPayload() — Method in class MessageBuilder: Set custom payload to go with the message
MessageEnvelope::setStatus() — Method in class MessageEnvelope: Set the status of this message envelope only possible if there is no final state set yet.
Sender — Class in namespace Wrep\Notificato\Apns
Sender::setGatewayFactory() — Method in class Sender: Set the gateway factory to use for creating connections to the APNS gateway
Sender::setLogger() — Method in class Sender: Sets a logger instance on the object
Sender::send() — Method in class Sender: Queues a message and flushes the gateway connection it must be send over immediately Note: If you send multiple messages, queue as many as possible and flush them at once for maximum performance
SslSocket — Class in namespace Wrep\Notificato\Apns
SslSocket::setLogger() — Method in class SslSocket: Sets a logger instance on the object
Notificato::send() — Method in class Notificato: Queues a message and flushes the gateway connection it must be send over immediately Note: If you send multiple messages, queue as many as possible and flush them at once for maximum performance
Notificato::setSender() — Method in class Notificato: Sets the sender to use.
Notificato::setLogger() — Method in class Notificato: Sets a logger instance on the object.
Notificato::setCertificateFactory() — Method in class Notificato: Sets the certificate factory to use.
Notificato::setFeedbackFactory() — Method in class Notificato: Sets the feedback factory to use.

T

Tuple — Class in namespace Wrep\Notificato\Apns\Feedback

U

Certificate::unserialize() — Method in class Certificate: Constructs the object from serialized data
Message::unserialize() — Method in class Message: Constructs the object from serialized data

V

ValidationException — Class in namespace Wrep\Notificato\Apns\Exception

_

Certificate::__construct() — Method in class Certificate: APNS Certificate constructor
CertificateFactory::__construct() — Method in class CertificateFactory: Create the CertificateFactory
Feedback::__construct() — Method in class Feedback: Construct Connection
FeedbackFactory::__construct() — Method in class FeedbackFactory: Create the FeedbackFactory
Tuple::__construct() — Method in class Tuple: Construct Tuple
Gateway::__construct() — Method in class Gateway: Construct Connection
Message::__construct() — Method in class Message: Construct Message
Message::__toString() — Method in class Message: Get a string representation of this object
MessageEnvelope::__construct() — Method in class MessageEnvelope: Construct MessageEnvelope
Sender::__construct() — Method in class Sender: Construct Sender
SslSocket::__construct() — Method in class SslSocket: Construct Connection
Notificato::__construct() — Method in class Notificato: Notificato constructor