Source of file ContactListEvent.php

Size: 5,854 Bytes - Last Modified: 2019-10-21T01:10:00+00:00

/data/development/sccp/sources/PAMI/src/PAMI/Message/Event/ContactListEvent.php

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271
<?php
/**
 * ContactList Event
 * isListEntry and Part Action: PJSIPShowContacts
 *
 * Note: Auto Generated using xsltproc
 *
 * PHP Version 5
 *
 * @category   Pami
 * @package    Message
 * @subpackage Event
 * @author     Marcelo Gornstein <marcelog@gmail.com>
 * @author     Diederik de Groot <ddegroot@gmail.com>
 * @license    http://github.com/chan-sccp/PAMI/LICENSE
 * @version    SVN: $Id$
 * @link       http://marcelog.github.com/PAMI/
 *
 * Copyright 2011 Marcelo Gornstein <marcelog@gmail.com>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
namespace PAMI\Message\Event;

use PAMI\Message\Event\EventMessage;

/**
 * ContactList Event
 * isListEntry and Part Action: PJSIPShowContacts
 *
 * Note: Auto Generated using xsltproc
 *
 * PHP Version 5
 *
 * @category   Pami
 * @package    Message
 * @subpackage Event
 * @author     Diederik de Groot <ddegroot@gmail.com>
 * @license    http://chan-sccp.github.com/PAMI/ Apache License 2.0
 * @link       http://github.com/chan-sccp/PAMI/
 */
class ContactListEvent extends EventMessage
{
    /**
     * get ObjectType
     *
     * Returns:The object's type. This will always be 'contact'.
     *
     * @return string
     */
    public function getObjectType()
    {
        return $this->getKey('ObjectType');
    }

    /**
     * get ObjectName
     *
     * Returns:The name of this object.
     *
     * @return string
     */
    public function getObjectName()
    {
        return $this->getKey('ObjectName');
    }

    /**
     * get ViaAddr
     *
     * Returns:IP address of the last Via header in REGISTER request. Will only appear in the event if available.
     *
     * @return string
     */
    public function getViaAddr()
    {
        return $this->getKey('ViaAddr');
    }

    /**
     * get ViaPort
     *
     * Returns:Port number of the last Via header in REGISTER request. Will only appear in the event if available.
     *
     * @return string
     */
    public function getViaPort()
    {
        return $this->getKey('ViaPort');
    }

    /**
     * get QualifyTimeout
     *
     * Returns:The elapsed time in decimal seconds after which an OPTIONS message is sent before the contact is considered unavailable.
     *
     * @return string
     */
    public function getQualifyTimeout()
    {
        return $this->getKey('QualifyTimeout');
    }

    /**
     * get CallId
     *
     * Returns:Content of the Call-ID header in REGISTER request. Will only appear in the event if available.
     *
     * @return string
     */
    public function getCallId()
    {
        return $this->getKey('CallId');
    }

    /**
     * get RegServer
     *
     * Returns:Asterisk Server name.
     *
     * @return string
     */
    public function getRegServer()
    {
        return $this->getKey('RegServer');
    }

    /**
     * get PruneOnBoot
     *
     * Returns:If true delete the contact on Asterisk restart/boot.
     *
     * @return string
     */
    public function getPruneOnBoot()
    {
        return $this->getKey('PruneOnBoot');
    }

    /**
     * get Path
     *
     * Returns:The Path header received on the REGISTER.
     *
     * @return string
     */
    public function getPath()
    {
        return $this->getKey('Path');
    }

    /**
     * get Endpoint
     *
     * Returns:The name of the endpoint associated with this information.
     *
     * @return string
     */
    public function getEndpoint()
    {
        return $this->getKey('Endpoint');
    }

    /**
     * get AuthenticateQualify
     *
     * Returns:A boolean indicating whether a qualify should be authenticated.
     *
     * @return string
     */
    public function getAuthenticateQualify()
    {
        return $this->getKey('AuthenticateQualify');
    }

    /**
     * get Uri
     *
     * Returns:This contact's URI.
     *
     * @return string
     */
    public function getUri()
    {
        return $this->getKey('Uri');
    }

    /**
     * get QualifyFrequency
     *
     * Returns:The interval in seconds at which the contact will be qualified.
     *
     * @return string
     */
    public function getQualifyFrequency()
    {
        return $this->getKey('QualifyFrequency');
    }

    /**
     * get UserAgent
     *
     * Returns:Content of the User-Agent header in REGISTER request
     *
     * @return string
     */
    public function getUserAgent()
    {
        return $this->getKey('UserAgent');
    }

    /**
     * get ExpirationTime
     *
     * Returns:Absolute time that this contact is no longer valid after
     *
     * @return string
     */
    public function getExpirationTime()
    {
        return $this->getKey('ExpirationTime');
    }

    /**
     * get OutboundProxy
     *
     * Returns:The contact's outbound proxy.
     *
     * @return string
     */
    public function getOutboundProxy()
    {
        return $this->getKey('OutboundProxy');
    }

    /**
     * get Status
     *
     * Returns:This contact's status.
     *
     * @return string
     */
    public function getStatus()
    {
        return $this->getKey('Status');
    }

    /**
     * get RoundtripUsec
     *
     * Returns:The round trip time in microseconds.
     *
     * @return string
     */
    public function getRoundtripUsec()
    {
        return $this->getKey('RoundtripUsec');
    }
}