opensim/OpenSim/Framework/Client/IClientIM.cs

/*
 * Copyright (c) Contributors, http://opensimulator.org/
 * See CONTRIBUTORS.TXT for a full list of copyright holders.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the OpenSimulator Project nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

using System;
using OpenMetaverse;

namespace OpenSim.Framework.Client
{
    public class ClientInstantMessageArgs : EventArgs
    {
        public IClientCore client;
        public string message;
        public DateTime time;
        public ClientInstantMessageSender sender;
    }

    public class ClientInstantMessageSender
    {
        public UUID ID;
        public bool online;
        public string name;
        public Vector3 position;
        public UUID regionID;
    }

    public delegate void ClientInstantMessage(Object sender, ClientInstantMessageArgs e);

    public class ClientInstantMessageParms
    {
        public ClientInstantMessageSender senderInfo;
    }

    // Porting Guide from old IM
    // SendIM(...)
    //      Loses FromAgentSession - this should be added by implementers manually.
    //      

    public interface IClientIM
    {
        void SendInstantMessage(UUID fromAgent, string message, UUID toAgent,
                                string fromName, byte dialog, uint timeStamp);

        void SendInstantMessage(UUID fromAgent, string message, UUID toAgent,
                                string fromName, byte dialog, uint timeStamp,
                                UUID transactionID, bool fromGroup,
                                byte[] binaryBucket);

        event ImprovedInstantMessage OnInstantMessage;
    }
}