asternet/Asterisk.2013/Asterisk.NET/Manager/Event/AbstractQueueMemberEvent.cs

namespace AsterNET.Manager.Event
{
    /// <summary>
    ///     Abstract base class for several queue member related events.
    /// </summary>
    public abstract class AbstractQueueMemberEvent : ManagerEvent
    {
        /// <summary>
        /// AbstractQueueMemberEvent contructor
        /// </summary>
        /// <param name="source">ManagerConnection passed through in the event.</param>
        public AbstractQueueMemberEvent(ManagerConnection source)
            : base(source)
        {
        }

        /// <summary>
        /// The name of the queue.
        /// </summary>
        public string Queue { get; set; }

        /// <summary>
        /// Returns the name of the member's interface.<br />
        /// E.g. the channel name or agent group.<br />
        /// <b>Removed since : </b> <see href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Documentation" target="_blank" alt="Asterisk 12 wiki docs">Asterisk 12</see>.<br/>
        /// <b>Replaced by : </b> <see cref="Interface"/> since <see href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Documentation" target="_blank" alt="Asterisk 12 wiki docs">Asterisk 12</see>.
        /// </summary>
        public string Location { get; set; }

        /// <summary>
        /// The queue member's channel technology or location.<br />
        /// <b>Available since : </b> <see href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Documentation" target="_blank" alt="Asterisk 12 wiki docs">Asterisk 12</see>.
        /// </summary>
        public string Interface { get; set; }

        /// <summary>
        /// Channel technology or location from which to read device state changes.<br />
        /// <b>Available since : </b> <see href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Documentation" target="_blank" alt="Asterisk 12 wiki docs">Asterisk 12</see>.
        /// </summary>
        public string StateInterface { get; set; }

        /// <summary>
        /// The name of the queue member.<br />
        /// <b>Available since : </b> <see href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Documentation" target="_blank" alt="Asterisk 12 wiki docs">Asterisk 12</see>.
        /// </summary>
        public string MemberName { get; set; }

        /// <summary>
		/// "dynamic" if the added member is a dynamic queue member,<br />
		/// "realtime" if the added member is a realtime queue member,<br />
		/// "static" if the added member is a static queue member.<br />
        /// <b>Available since : </b> <see href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Documentation" target="_blank" alt="Asterisk 12 wiki docs">Asterisk 12</see>.
        /// </summary>
        public string Membership { get; set; }

        /// <summary>
        /// The penalty associated with the queue member. When calls are distributed members with higher penalties are considered last.<br />
        /// <b>Available since : </b> <see href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Documentation" target="_blank" alt="Asterisk 12 wiki docs">Asterisk 12</see>.
        /// </summary>
        public int Penalty { get; set; }

        /// <summary>
        /// The number of calls this queue member has serviced.<br />
        /// <b>Available since : </b> <see href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Documentation" target="_blank" alt="Asterisk 12 wiki docs">Asterisk 12</see>.
        /// </summary>
        public int CallsTaken { get; set; }

        /// <summary>
        /// The time this member last took a call, expressed in seconds since 00:00, Jan 1, 1970 UTC.<br />
        /// <b>Available since : </b> <see href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Documentation" target="_blank" alt="Asterisk 12 wiki docs">Asterisk 12</see>.
        /// </summary>
        public long LastCall { get; set; }

        /// <summary>
        /// When queue member is paused (not accepting calls).<br/>
        /// Evaluates <see langword="true"/> if this member has been paused,
        /// <see langword="false"/> if not.<br />
        /// <b>Available since : </b> <see href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Documentation" target="_blank" alt="Asterisk 12 wiki docs">Asterisk 12</see>.
        /// </summary>
        public bool Paused { get; set; }

        /// <summary>
        /// The numeric device state status of the queue member.<br/>
        /// <para>
        /// Valid status codes are:<br/>
        /// <list type="number" start="0">
        /// <item>AST_DEVICE_UNKNOWN</item>
        /// <item>AST_DEVICE_NOT_INUSE</item>
        /// <item>AST_DEVICE_INUSE</item>
        /// <item>AST_DEVICE_BUSY</item>
        /// <item>AST_DEVICE_INVALID</item>
        /// <item>AST_DEVICE_UNAVAILABLE</item>
        /// <item>AST_DEVICE_RINGING</item>
        /// <item>AST_DEVICE_RINGINUSE</item>
        /// <item>AST_DEVICE_ONHOLD</item>
        /// </list>
        /// </para>
        /// <b>Available since : </b> <see href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Documentation" target="_blank" alt="Asterisk 12 wiki docs">Asterisk 12</see>.
        /// </summary>
        public int Status { get; set; }

        /// <summary>
        /// Evaluates <see langword="true"/> if Ringinuse,
        /// <see langword="false"/> if not.<br />
        /// <b>Available since : </b> <see href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Documentation" target="_blank" alt="Asterisk 12 wiki docs">Asterisk 12</see>.
        /// </summary>
        public bool Ringinuse { get; set; }

        /// <summary>
        /// Evaluates <see langword="true"/> if member is in call,
        /// <see langword="false"/> after LastCall time is updated.<br />
        /// <b>Available since : </b> <see href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Documentation" target="_blank" alt="Asterisk 13 wiki docs">Asterisk 13</see>.
        /// </summary>
        public bool InCall { get; set; }

        /// <summary>
        /// If set when paused, the reason the queue member was paused.<br />
        /// <b>Available since : </b> <see href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Documentation" target="_blank" alt="Asterisk 13 wiki docs">Asterisk 13</see>.
        /// </summary>
        public string PausedReason { get; set; }
    }
}