IQ.cs :  » Network-Clients » Jabber-Net » jabber » protocol » client » C# / CSharp Open Source

/* --------------------------------------------------------------------------
 *
 * License
 *
 * The contents of this file are subject to the Jabber Open Source License
 * Version 1.0 (the "License").  You may not copy or use this file, in either
 * source code or executable form, except in compliance with the License.  You
 * may obtain a copy of the License at http://www.jabber.com/license/ or at
 * http://www.opensource.org/.  
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied.  See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * Copyrights
 * 
 * Portions created by or assigned to Cursive Systems, Inc. are 
 * Copyright (c) 2002 Cursive Systems, Inc.  All Rights Reserved.  Contact
 * information for Cursive Systems, Inc. is available at http://www.cursive.net/.
 *
 * Portions Copyright (c) 2002 Joe Hildebrand.
 * 
 * Acknowledgements
 * 
 * Special thanks to the Jabber Open Source Contributors for their
 * suggestions and support of Jabber.
 * 
 * --------------------------------------------------------------------------*/
using System;
using System.Xml;

using bedrock.util;

namespace jabber.protocol.client{
    /// <summary>
    /// IQ type attribute
    /// </summary>
    public enum IQType
    {
        /// <summary>
        /// type='get'
        /// </summary>
        get,
        /// <summary>
        /// type='set'
        /// </summary>
        set,
        /// <summary>
        /// type='result'
        /// </summary>
        result,
        /// <summary>
        /// type='error'
        /// </summary>
        error
    }

    /// <summary>
    /// All IQ packets start here.  The Query property holds the interesting part.
    /// There should usually be a convenience class next to the Query type, which
    /// creates an IQ with the appropriate type of query inside.
    /// </summary>
    [RCS(@"$Header: /home/cvs/jabber-net/jabber/protocol/client/IQ.cs,v 1.1 2002/07/11 21:59:35 hildjj Exp $")]
    public class IQ : Packet
    {
        /// <summary>
        /// 
        /// </summary>
        /// <param name="doc"></param>
        public IQ(XmlDocument doc) : base("iq", doc)
        {
            ID   = NextID();
            Type = IQType.get;  // get better errors than when there is no type specified.
        }
        /// <summary>
        /// 
        /// </summary>
        /// <param name="prefix"></param>
        /// <param name="qname"></param>
        /// <param name="doc"></param>
        public IQ(string prefix, XmlQualifiedName qname, XmlDocument doc) : 
            base(qname.Name, doc)
        {
        }

        /// <summary>
        /// 
        /// </summary>
        public IQType Type
        {
            get { return (IQType) GetEnumAttr("type", typeof(IQType)); }
            set 
            { 
                IQType cur = this.Type;
                if (cur == value)
                    return;
                // FIXME: this should iterate through child elements, removing them, I think.
                if (value == IQType.error)
                {
                    this.InnerXml = "";
                    this.AppendChild(new Error(this.OwnerDocument));
                }
                SetAttribute("type", value.ToString());
            }
        }
        /// <summary>
        /// IQ error.
        /// </summary>
        public Error Error
        {
            get { return (Error) this["error"]; }
            set 
            {
                this.Type = IQType.error;    
                ReplaceChild(value); 
            }
        }

        /// <summary>
        /// The query tag inside, regardless of namespace.
        /// If the iq contains something other than query,
        /// use normal XmlElement routines.
        /// </summary>
        public XmlElement Query
        {
            get { return this["query"]; }
            set { AddChild(value); }
        }
    }
}