protocol/client/Presence.cs

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Copyright (c) 2003-2012 by AG-Software 											 *
 * All Rights Reserved.																 *
 * Contact information for AG-Software is available at http://www.ag-software.de	 *
 *																					 *
 * Licence:																			 *
 * The agsXMPP SDK is released under a dual licence									 *
 * agsXMPP can be used under either of two licences									 *
 * 																					 *
 * A commercial licence which is probably the most appropriate for commercial 		 *
 * corporate use and closed source projects. 										 *
 *																					 *
 * The GNU Public License (GPL) is probably most appropriate for inclusion in		 *
 * other open source projects.														 *
 *																					 *
 * See README.html for details.														 *
 *																					 *
 * For general enquiries visit our website at:										 *
 * http://www.ag-software.de														 *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

using System;

using agsXMPP.protocol.extensions.primary;
using agsXMPP.protocol.extensions.nickname;
using agsXMPP.protocol.extensions.caps;

namespace agsXMPP.protocol.client
{
	/// <summary>
	/// Zusammenfassung f�r Presence.
	/// </summary>
	public class Presence : Base.StanzaWithError
    {
        #region << Constructors >>
        public Presence()
		{
			this.TagName	= "presence";
			this.Namespace	= Uri.CLIENT;
		}

		public Presence(ShowType show, string status) : this()
		{
			this.Show		= show;
			this.Status		= status;
		}

		public Presence(ShowType show, string status, int priority) : this(show, status)
		{
			this.Priority	= priority;
        }
        #endregion

        /// <summary>
        /// The OPTIONAL statuc contains a natural-language description of availability status.
        /// It is normally used in conjunction with the show element to provide a detailed description of an availability state
        /// (e.g., "In a meeting").
        /// </summary>
		public string Status
		{
			get { return GetTag("status"); }
			set { SetTag("status", value); }
		}

        /// <summary>
        /// The type of a presence stanza is OPTIONAL.
        /// A presence stanza that does not possess a type attribute is used to signal to the server that the sender is online and available
        /// for communication. If included, the type attribute specifies a lack of availability, a request to manage a subscription
        /// to another entity's presence, a request for another entity's current presence, or an error related to a previously-sent
        /// presence stanza.
        /// </summary>
		public PresenceType Type
		{
			get
			{
				return (PresenceType) GetAttributeEnum("type", typeof(PresenceType));
			}
			set
			{
				// dont add type="available"
				if (value == PresenceType.available)
					RemoveAttribute("type");
				else
					SetAttribute("type", value.ToString());
			}

		}

        /// <summary>
        /// The OPTIONAL show element contains non-human-readable XML character data that specifies the particular availability
        /// status of an entity or specific resource.
        /// </summary>
		public ShowType Show
		{
			get { return (ShowType) GetTagEnum("show", typeof(ShowType)); }
			set
			{
                if (value != ShowType.NONE)
                    SetTag("show", value.ToString());
                else
                    RemoveAttribute("show");
			}
		}

		/// <summary>
        /// The priority level of the resource. The value MUST be an integer between -128 and +127.
        /// If no priority is provided, a server SHOULD consider the priority to be zero.
		/// </summary>
        /// <remarks>
        /// For information regarding the semantics of priority values in stanza routing
        /// within instant messaging and presence applications, refer to Server Rules
        /// for Handling XML StanzasServer Rules for Handling XML Stanzas.
        /// </remarks>
		public int Priority
		{
			get
			{
				try
				{
					return int.Parse(GetTag("priority"));
				}
				catch
				{
					return 0;
				}
			}
			set { SetTag("priority", value.ToString()); }
		}

		public x.Delay XDelay
		{
			get	{ return SelectSingleElement(typeof(x.Delay)) as x.Delay; }
			set
            {
                if (HasTag(typeof(x.Delay)))
                    RemoveTag(typeof(x.Delay));

                if (value != null)
                    this.AddChild(value);
            }
		}

		public bool IsPrimary
		{
			get
			{
				return GetTag(typeof(Primary)) == null ? false : true;
			}
			set
			{
				if (value)
					SetTag(typeof(Primary));
				else
					RemoveTag(typeof(Primary));
			}
		}

        /// <summary>
        ///
        /// </summary>
        public x.muc.User MucUser
        {
            get { return SelectSingleElement(typeof(x.muc.User)) as x.muc.User; }
            set
            {
                if (HasTag(typeof(x.muc.User)))
                    RemoveTag(typeof(x.muc.User));

                if (value != null)
                    this.AddChild(value);
            }
        }

        /// <summary>
        /// The muc element. Doesn't have much use
        /// </summary>
        public x.muc.Muc Muc
        {
            get { return SelectSingleElement(typeof(x.muc.Muc)) as x.muc.Muc; }
            set
            {
                if (HasTag(typeof(x.muc.Muc)))
                    RemoveTag(typeof(x.muc.Muc));

                if (value != null)
                    this.AddChild(value);
            }
        }

        /// <summary>
        /// in case of away, says how long the user was idle
        /// </summary>
        public iq.last.Last Last
        {
            get { return SelectSingleElement(typeof(iq.last.Last)) as iq.last.Last; }
            set
            {
                if (HasTag(typeof(iq.last.Last)))
                    RemoveTag(typeof(iq.last.Last));

                if (value != null)
                    this.AddChild(value);
            }
        }

        /// <summary>
        /// Nickname Element
        /// </summary>
        public Nickname Nickname
        {
            get
            {
                return SelectSingleElement(typeof(Nickname)) as Nickname;
            }
            set
            {
                if (HasTag(typeof(Nickname)))
                    RemoveTag(typeof(Nickname));

                if (value != null)
                    AddChild(value);
            }
        }

        public Capabilities Capabilities
        {
            get
            {
                return SelectSingleElement<Capabilities>();
            }
            set
            {
                RemoveTag<Capabilities>();

                if (value != null)
                    AddChild(value);
            }
        }
	}
}