/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 *                                                                                     *
 * Copyright (c) 2005 by AG-Software                                                 *
 * All Rights Reserved.                                                                 *
 *                                                                                     *
 * You should have received a copy of the AG-Software Shared Source License             *
 * along with this library; if not, email gnauck@ag-software.de to request a copy.   *
 *                                                                                     *
 * For general enquiries, email gnauck@ag-software.de or visit our website at:         *
 * http://www.ag-software.net                                                         *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

using System;

using agsXMPP.Xml.Dom;

namespace agsXMPP.protocol.x
{
    /// <summary>
    /// JEP-0022: Message Events
    /// This JEP defines protocol extensions used to request and respond to events relating to the delivery, display, and composition of messages.
    /// </summary>
    public class Event : Element
    {
        public Event()
        {
            this.TagName = &quot;x&quot;;
            this.Namespace = Uri.X_EVENT;
        }

        /// <summary>
        /// Indicates that the message has been stored offline by the intended recipient's server.
        /// This event is triggered only if the intended recipient's server supports offline storage,
        /// has that support enabled, and the recipient is offline when the server receives the message for delivery.
        /// </summary>
        public bool Offline
        {
            get { return HasTag(&quot;offline&quot;); }
            set
            {
                RemoveTag(&quot;offline&quot;);
                if (value)
                    AddTag(&quot;offline&quot;);
            }
           
        }

        /// <summary>
        /// Indicates that the message has been delivered to the recipient.
        /// This signifies that the message has reached the recipient's Jabber client,
        /// but does not necessarily mean that the message has been displayed.
        /// This event is to be raised by the Jabber client.
        /// </summary>
        public bool Delivered
        {
            get { return HasTag(&quot;delivered&quot;); }
            set
            {
                RemoveTag(&quot;delivered&quot;);
                if (value)
                    AddTag(&quot;delivered&quot;);
            }
           
        }
       
        /// <summary>
        /// Once the message has been received by the recipient's Jabber client,
        /// it may be displayed to the user.
        /// This event indicates that the message has been displayed, and is to be raised by the Jabber client.
        /// Even if a message is displayed multiple times, this event should be raised only once.
        /// </summary>
        public bool Displayed
        {
            get { return HasTag(&quot;displayed&quot;); }
            set
            {
                RemoveTag(&quot;displayed&quot;);
                if (value)
                    AddTag(&quot;displayed&quot;);
            }
           
        }
       
        /// <summary>
        /// In threaded chat conversations, this indicates that the recipient is composing a reply to a message.
        /// The event is to be raised by the recipient's Jabber client.
        /// A Jabber client is allowed to raise this event multiple times in response to the same request,
        /// providing the original event is cancelled first.
        /// </summary>
        public bool Composing
        {
            get { return HasTag(&quot;composing&quot;); }
            set
            {
                RemoveTag(&quot;composing&quot;);
                if (value)
                    AddTag(&quot;composing&quot;);
            }
           
        }

        /// <summary>
        /// 'id' attribute of the original message to which this event notification pertains.
        /// (If no 'id' attribute was included in the original message, then the id tag must still be included with no
        /// </summary>
        public string Id
        {
            get { return GetTag(&quot;id&quot;); }
            set { SetTag(&quot;id&quot;); }
        }
    }

}