PAMI\Message\Event\PeerEntryEvent

Event triggered for each peer when an action Sippeers is issued.

PHP Version 5

Constants

EOL

const EOL = "\r\n"

EOM

const EOM = "\r\n\r\n"

Properties

$rawContent

protected string $rawContent

Holds original message.

  • Visibility: protected

$channelVariables

protected array<mixed,string> $channelVariables

Metadata. Specific channel variables.

  • Visibility: protected

$lines

protected array<mixed,string> $lines

Message content, line by line. This is what it gets sent or received literally.

  • Visibility: protected

$variables

protected array<mixed,string> $variables

Metadata. Message variables (key/value).

  • Visibility: protected

$keys

protected array<mixed,string> $keys

Metadata. Message "keys" i.e: Action: login

  • Visibility: protected

$createdDate

protected integer $createdDate

Created date (unix timestamp).

  • Visibility: protected

Methods

getChannelType

string PAMI\Message\Event\PeerEntryEvent::getChannelType()

Returns key: 'ChannelType'.

  • Visibility: public

getObjectName

string PAMI\Message\Event\PeerEntryEvent::getObjectName()

Returns key: 'ObjectName'.

  • Visibility: public

getChannelObjectType

string PAMI\Message\Event\PeerEntryEvent::getChannelObjectType()

Returns key: 'ChanObjectType'.

  • Visibility: public

getIPAddress

string PAMI\Message\Event\PeerEntryEvent::getIPAddress()

Returns key: 'IPAddress'.

  • Visibility: public

getIPPort

string PAMI\Message\Event\PeerEntryEvent::getIPPort()

Returns key: 'IPPort'.

  • Visibility: public

getDynamic

string PAMI\Message\Event\PeerEntryEvent::getDynamic()

Returns key: 'Dynamic'.

  • Visibility: public

getNatSupport

string PAMI\Message\Event\PeerEntryEvent::getNatSupport()

Returns key: 'NatSupport'.

  • Visibility: public

getVideoSupport

string PAMI\Message\Event\PeerEntryEvent::getVideoSupport()

Returns key: 'VideoSupport'.

  • Visibility: public

getTextSupport

string PAMI\Message\Event\PeerEntryEvent::getTextSupport()

Returns key: 'TextSupport'.

  • Visibility: public

getACL

string PAMI\Message\Event\PeerEntryEvent::getACL()

Returns key: 'ACL'.

  • Visibility: public

getStatus

string PAMI\Message\Event\PeerEntryEvent::getStatus()

Returns key: 'Status'.

  • Visibility: public

getRealtimeDevice

string PAMI\Message\Event\PeerEntryEvent::getRealtimeDevice()

Returns key: 'RealtimeDevice'.

  • Visibility: public

getName

string PAMI\Message\Event\EventMessage::getName()

Returns key 'Event'.

__sleep

array<mixed,string> PAMI\Message\Message::__sleep()

Serialize function.

getEventList

string PAMI\Message\IncomingMessage::getEventList()

Returns key 'EventList'. In respones, this will surely be a "start". In events, should be a "complete".

getRawContent

string PAMI\Message\IncomingMessage::getRawContent()

Returns the original message content without parsing.

getAllChannelVariables

array PAMI\Message\IncomingMessage::getAllChannelVariables()

Returns the channel variables for all reported channels.

https://github.com/marcelog/PAMI/issues/85

The channel names will be lowercased.

getChannelVariables

array PAMI\Message\IncomingMessage::getChannelVariables(string $channel)

Returns the channel variables for the given channel.

https://github.com/marcelog/PAMI/issues/85

Arguments

  • $channel string - <p>Channel name. If not given, will return variables for the "current" channel.</p>

__construct

void PAMI\Message\Message::__construct()

Constructor.

getCreatedDate

integer PAMI\Message\Message::getCreatedDate()

Returns created date.

setVariable

void PAMI\Message\Message::setVariable(string $key, string $value)

Adds a variable to this message.

Arguments

  • $key string - <p>Variable name.</p>
  • $value string - <p>Variable value.</p>

getVariable

string PAMI\Message\Message::getVariable(string $key)

Returns a variable by name.

Arguments

  • $key string - <p>Variable name.</p>

setKey

void PAMI\Message\Message::setKey(string $key, string $value)

Adds a variable to this message.

Arguments

  • $key string - <p>Key name (i.e: Action).</p>
  • $value string - <p>Key value.</p>

getKey

string PAMI\Message\Message::getKey(string $key)

Returns a key by name.

Arguments

  • $key string - <p>Key name (i.e: Action).</p>

getKeys

array<mixed,string> PAMI\Message\Message::getKeys()

Returns all keys for this message.

getVariables

array<mixed,string> PAMI\Message\Message::getVariables()

Returns all variabels for this message.

finishMessage

string PAMI\Message\Message::finishMessage($message)

Returns the end of message token appended to the end of a given message.

Arguments

  • $message mixed

serializeVariable

string PAMI\Message\Message::serializeVariable(string $key, string $value)

Returns the string representation for an ami action variable.

Arguments

  • $key string
  • $value string

serialize

string PAMI\Message\Message::serialize()

Gives a string representation for this message, ready to be sent to ami.

getActionID

string PAMI\Message\Message::getActionID()

Returns key: 'ActionID'.