asternet/Asterisk.2013/Asterisk.NET/Manager/Action/SIPShowPeerAction.cs

using System;
using AsterNET.Manager.Event;

namespace AsterNET.Manager.Action
{
    /// <summary>
    ///     Retrieves a the details about a given SIP peer.<br />
    ///     For a PeerEntryEvent is sent by Asterisk containing the details of the peer
    ///     followed by a PeerlistCompleteEvent.<br />
    ///     Available since Asterisk 1.2
    /// </summary>
    /// <seealso cref="Manager.event.PeerEntryEvent" />
    /// <seealso cref="Manager.event.PeerlistCompleteEvent" />
    public class SIPShowPeerAction : ManagerActionEvent
    {
        /// <summary> Creates a new empty SIPShowPeerAction.</summary>
        public SIPShowPeerAction()
        {
        }

        /// <summary>
        ///     Creates a new SIPShowPeerAction that requests the details about the given SIP peer.
        /// </summary>
        public SIPShowPeerAction(string peer)
        {
            this.Peer = peer;
        }

        public override string Action
        {
            get { return "SIPShowPeer"; }
        }

        /// <summary>
        ///     Get/Set the name of the peer to retrieve.<br />
        ///     This parameter is mandatory.
        /// </summary>
        public string Peer { get; set; }

        public override Type ActionCompleteEventClass()
        {
            return typeof (PeerlistCompleteEvent);
        }
    }
}