PAMI\Message\Event\AuthDetailEvent
Event from PJSIPShowEndpoint
PHP Version 5
- Author: Niklas Larsson <niklas@tese.se>
- License: http://marcelog.github.com/PAMI/ Apache License 2.0
Synopsis
class AuthDetailEvent
extends EventMessage
{
- // methods
- public string getObjectType()
- public string getObjectName()
- public string getUsername()
- public string getPassword()
- public string getMd5Cred()
- public string getRealm()
- public string getNonceLifetime()
- public string getAuthType()
- public string getEndpointName()
- // 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
- getAuthType() — Returns key: 'AuthType'. Authentication type
- getEndpointName() — Returns key: 'EndpointName'. The name of the endpoint associated with this information.
- getMd5Cred() — Returns key: 'Md5Cred'. MD5 Hash used for authentication.
- getNonceLifetime() — Returns key: 'NonceLifetime'. Lifetime of a nonce associated with this authentication config.
- getObjectName() — Returns key: 'ObjectName'. The name of this object.
- getObjectType() — Returns key: 'ObjectType'. The object's type. This will always be 'auth'.
- getPassword() — Returns key: 'Password'. Username to use for account
- getRealm() — Returns key: 'Realm'. SIP realm for endpoint
- getUsername() — Returns key: 'Username'. Username to use for account
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.