it.auties.whatsapp.model.action.ClearChatAction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of whatsappweb4j Show documentation

Standalone fully-featured Whatsapp Web API for Java and Kotlin

There is a newer version: 3.5.1

package it.auties.whatsapp.model.action;

import it.auties.protobuf.base.ProtobufProperty;
import it.auties.whatsapp.binary.BinaryPatchType;
import it.auties.whatsapp.model.sync.ActionMessageRangeSync;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.experimental.Accessors;
import lombok.extern.jackson.Jacksonized;

import java.util.Optional;

import static it.auties.protobuf.base.ProtobufType.MESSAGE;

/**
 * A model clas that represents a cleared chat
 */
@AllArgsConstructor
@Data
@Builder
@Jacksonized
@Accessors(fluent = true)
public final class ClearChatAction implements Action {
    /**
     * The message range on which this action has effect
     */
    @ProtobufProperty(index = 1, type = MESSAGE, implementation = ActionMessageRangeSync.class)
    private ActionMessageRangeSync messageRange;

    /**
     * Returns the range of messages that were cleared
     *
     * @return an optional
     */
    public Optional messageRange() {
        return Optional.ofNullable(messageRange);
    }

    /**
     * The name of this action
     *
     * @return a non-null string
     */
    @Override
    public String indexName() {
        return "clearChat";
    }

    /**
     * The version of this action
     *
     * @return a non-null string
     */
    @Override
    public int actionVersion() {
        return 6;
    }

    /**
     * The type of this action
     *
     * @return a non-null string
     */
    @Override
    public BinaryPatchType actionType() {
        return null;
    }
}