/Aurora/Framework/DatabaseInterfaces/IOfflineMessagesConnector.cs

 1/*
 2 * Copyright (c) Contributors, http://aurora-sim.org/
 3 * See CONTRIBUTORS.TXT for a full list of copyright holders.
 4 *
 5 * Redistribution and use in source and binary forms, with or without
 6 * modification, are permitted provided that the following conditions are met:
 7 *     * Redistributions of source code must retain the above copyright
 8 *       notice, this list of conditions and the following disclaimer.
 9 *     * Redistributions in binary form must reproduce the above copyright
10 *       notice, this list of conditions and the following disclaimer in the
11 *       documentation and/or other materials provided with the distribution.
12 *     * Neither the name of the Aurora-Sim Project nor the
13 *       names of its contributors may be used to endorse or promote products
14 *       derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28using System.Collections.Generic;
29using Aurora.Framework.ClientInterfaces;
30using Aurora.Framework.Services;
31using OpenMetaverse;
32
33namespace Aurora.Framework.DatabaseInterfaces
34{
35    public interface IOfflineMessagesConnector : IAuroraDataPlugin
36    {
37        /// <summary>
38        ///     Gets all offline messages for the user in GridInstantMessage format.
39        /// </summary>
40        /// <param name="agentID"></param>
41        /// <returns></returns>
42        List<GridInstantMessage> GetOfflineMessages(UUID agentID);
43
44        /// <summary>
45        ///     Adds a new offline message for the user.
46        /// </summary>
47        /// <param name="message"></param>
48        /// <returns>Whether it was successfully added</returns>
49        bool AddOfflineMessage(GridInstantMessage message);
50    }
51}