Source of file EndpointListEvent.php

Size: 3,362 Bytes - Last Modified: 2019-04-30T12:53:24+00:00

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

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
<?php
/**
 * Event from PJSIPShowEndpoints
 * Provide details about a device/endpoint/contact's status.
 *
 * PHP Version 5
 *
 * @category   Pami
 * @package    Message
 * @subpackage Event
 * @author     Niklas Larsson <niklas@tese.se>
 * @license    http://marcelog.github.com/PAMI/ Apache License 2.0
 * @version    SVN: $Id$
 * @link       http://marcelog.github.com/PAMI/
 *
 * Copyright 2015 Niklas Larsson <niklas@tese.se>, 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;

/**
 * Event from PJSIPShowEndpoints
 *
 * PHP Version 5
 *
 * @category   Pami
 * @package    Message
 * @subpackage Event
 * @author     Niklas Larsson <niklas@tese.se>
 * @license    http://marcelog.github.com/PAMI/ Apache License 2.0
 * @link       http://marcelog.github.com/PAMI/
 */
class EndpointListEvent extends EventMessage
{
    /**
     * The object's type. This will always be 'endpoint'.
     *
     * @return string key: 'ObjectType'
     */
    public function getObjectType()
    {
        return $this->getKey('ObjectType');
    }

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

    /**
     * The transport configurations associated with this endpoint.
     *
     * @return string key: 'Transport'.
     */
    public function getTransport()
    {
        return $this->getKey('Transport');
    }

    /**
     * The aor configurations associated with this endpoint.
     *
     * @return string key: 'Aor'.
     */
    public function getAor()
    {
        return $this->getKey('Aor');
    }

    /**
     * The inbound authentication configurations associated with this endpoint.
     *
     * @return string key: 'Auths'.
     */
    public function getAuths()
    {
        return $this->getKey('Auths');
    }

    /**
     * The outbound authentication configurations associated with this endpoint.
     *
     * @return string key: 'OutboundAuths'.
     */
    public function getOutboundAuths()
    {
        return $this->getKey('OutboundAuths');
    }

    /**
     * Returns key: 'Contacts'.
     *
     * @return string
     */
    public function getContacts()
    {
        return $this->getKey('Contacts');
    }

    /**
     * The aggregate device state for this endpoint.
     *
     * @return string key: 'DeviceState'.
     */
    public function getDeviceState()
    {
        return $this->getKey('DeviceState');
    }

    /**
     * The number of active channels associated with this endpoint.
     *
     * @return integer for key: 'ActiveChannels'.
     */
    public function getActiveChannels()
    {
        return intval($this->getKey('ActiveChannels'));
    }
}