chat.dim.dbi.GroupHistoryDBI Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of Common Show documentation
Decentralized Instant Messaging (Java SDK)
There is a newer version: 0.3.2
/* license: https://mit-license.org
 *
 *  DIMP : Decentralized Instant Messaging Protocol
 *
 *                                Written in 2023 by Moky 
 *
 * ==============================================================================
 * The MIT License (MIT)
 *
 * Copyright (c) 2023 Albert Moky
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 * ==============================================================================
 */
package chat.dim.dbi;

import java.util.List;

import chat.dim.protocol.GroupCommand;
import chat.dim.protocol.ID;
import chat.dim.protocol.ReliableMessage;
import chat.dim.protocol.group.ResetCommand;
import chat.dim.type.Pair;

public interface GroupHistoryDBI {

    /**
     *  Save group commands
     *      1. invite
     *      2. expel (deprecated)
     *      3. join
     *      4. quit
     *      5. reset
     *      6. resign
     *
     * @param content - group command
     * @param rMsg    - group command message
     * @param group   - group ID
     * @return false on failed
     */
    boolean saveGroupHistory(GroupCommand content, ReliableMessage rMsg, ID group);

    /**
     *  Load group commands
     *      1. invite
     *      2. expel (deprecated)
     *      3. join
     *      4. quit
     *      5. reset
     *      6. resign
     *
     * @param group - group ID
     * @return history list
     */
    List> getGroupHistories(ID group);

    /**
     *  Load last 'reset' group command
     *
     * @param group - group ID
     * @return reset command message
     */
    Pair getResetCommandMessage(ID group);

    /**
     *  Clean group commands for members:
     *      1. invite
     *      2. expel (deprecated)
     *      3. join
     *      4. quit
     *      5. reset
     *
     * @param group - group ID
     * @return false on failed
     */
    boolean clearGroupMemberHistories(ID group);

    /**
     *  Clean group commands for administrators
     *      1. resign
     *
     * @param group - group ID
     * @return false on failed
     */
    boolean clearGroupAdminHistories(ID group);
}