PAMI\Message\Event\SuccessfulAuthEvent
Event triggered when an agent logs in.
PHP Version 5
- Author: Diederik de Groot <ddegroot@users.sf.net>
- License: http://marcelog.github.com/PAMI/ Apache License 2.0
Synopsis
class SuccessfulAuthEvent
extends EventMessage
{
- // methods
- public string getPrivilege()
- public int getSequenceNumber()
- public string getFile()
- public int getLine()
- public string getFunc()
- public string getEventTV()
- public string getSeverity()
- public string getService()
- public int getEventVersion()
- public string getAccountID()
- public string getSessionID()
- public string getLocalAddress()
- public string getRemoteAddress()
- public boolean getUsingPassword()
- public string getSessionTV()
- // 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
- getAccountID() — Returns key: 'AccountID'.
- getEventTV() — Returns key: 'EventTV'.
- getEventVersion() — Returns key: 'EventVersion'.
- getFile() — Returns key: 'File'.
- getFunc() — Returns key: 'Func'.
- getLine() — Returns key: 'Line'.
- getLocalAddress() — Returns key: 'LocalAddress'.
- getPrivilege() — Returns key: 'Privilege'.
- getRemoteAddress() — Returns key: 'RemoteAddress'.
- getSequenceNumber() — Returns key: 'SequenceNumber'.
- getService() — Returns key: 'Service'.
- getSessionID() — Returns key: 'SessionID'.
- getSessionTV() — Returns key: 'SessionTV'.
- getSeverity() — Returns key: 'Severity'.
- getUsingPassword() — Returns key: 'UsingPassword'.
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.