PAMI\Message\Event\AorDetailEvent
Event from PJSIPShowEndpoint
PHP Version 5
- Author: Niklas Larsson <niklas@tese.se>
- License: http://marcelog.github.com/PAMI/ Apache License 2.0
Synopsis
class AorDetailEvent
extends EventMessage
{
- // methods
- public string getObjectType()
- public string getObjectName()
- public string getMinimumExpiration()
- public string getMaximumExpiration()
- public string getDefaultExpiration()
- public string getQualifyFrequency()
- public string getAuthenticateQualify()
- public string getMaxContacts()
- public string getRemoveExisting()
- public string getMailboxes()
- public string getOutboundProxy()
- public string getSupportPath()
- public string getTotalContacts()
- public string getContactsRegistered()
- public string getEndpointName()
- public string getContact()
- public string getContacts()
- // Inherited methods from EventMessage
- public string getName()
- // Inherited methods from IncomingMessage
- public array __sleep()
- public string getEventList()
- public string getRawContent()
- public array getAllChannelVariables()
- public array getChannelVariables()
- public array getAllStatusVariables()
- public array getStatusVariables()
- public void __construct()
- // Inherited methods from Message
- public integer getCreatedDate()
- public void setVariable()
- public string getVariable()
- public string getKey()
- public string getBoolKey()
- public array getKeys()
- public array getVariables()
- public string serialize()
- public string getActionID()
- public void __construct()
Hierarchy
Extends
Constants
| Name | Value |
|---|---|
| EOL | "\r\n" |
| EOM | "\r\n\r\n" |
Methods
public
- getAuthenticateQualify() — Returns key: 'AuthenticateQualify'. Authenticates a qualify request if needed
- getContact() — Returns key: 'Contact'.
- getContacts() — Returns key: 'Contacts'.
- getContactsRegistered() — Returns key: 'ContactsRegistered'. The number of non-permanent contacts associated with this AoR.
- getDefaultExpiration() — Returns key: 'DefaultExpiration'. Default expiration time in seconds for contacts that are dynamicallybound to an AoR.
- getEndpointName() — Returns key: 'EndpointName'. The name of the endpoint associated with this information.
- getMailboxes() — Returns key: 'Mailboxes'. Allow subscriptions for the specified mailbox(es)
- getMaxContacts() — Returns key: 'MaxContacts'. Maximum number of contacts that can bind to an AoR
- getMaximumExpiration() — Returns key: 'MaximumExpiration'. Maximum time to keep an AoR
- getMinimumExpiration() — Returns key: 'MinimumExpiration'. Minimum keep alive time for an AoR
- getObjectName() — Returns key: 'ObjectName'. The name of this object.
- getObjectType() — Returns key: 'ObjectType'. The object's type. This will always be 'aor'.
- getOutboundProxy() — Returns key: 'OutboundProxy'. Outbound proxy used when sending OPTIONS request
- getQualifyFrequency() — Returns key: 'QualifyFrequency'. Interval at which to qualify an AoR
- getRemoveExisting() — Returns key: 'RemoveExisting'. Determines whether new contacts replace existing ones.
- getSupportPath() — Returns key: 'SupportPath'. Enables Path support for REGISTER requests and Route support forother requests.
- getTotalContacts() — Returns key: 'TotalContacts'. The total number of contacts associated with this AoR.
Inherited from PAMI\Message\Event\EventMessage
public
- getName() — Returns key 'Event'.
Inherited from PAMI\Message\IncomingMessage
public
- __sleep() — Serialize function.
- getAllChannelVariables() — Returns the channel variables for all reported channels.
- getAllStatusVariables() — Returns the channel variables for all reported channels.
- getChannelVariables() — Returns the channel variables for the given channel.
- getEventList() — Returns key 'EventList'. In respones, this will surely be a "start". In events, should be a "complete".
- getRawContent() — Returns the original message content without parsing.
- getStatusVariables() — Returns the channel variables for the given channel.
Inherited from PAMI\Message\Message
public
- getActionID() — Returns key: 'ActionID'.
- getBoolKey() — Returns a key by name.
- getCreatedDate() — Returns created date.
- getKey() — Returns a key by name.
- getKeys() — Returns all keys for this message.
- getVariable() — Returns a variable by name.
- getVariables() — Returns all variabels for this message.
- serialize() — Gives a string representation for this message, ready to be sent to ami.
- setVariable() — Adds a variable to this message.