twitch-bot/internal/actors/delete/actor.go

// Package deleteactor contains an actor to delete messages
package deleteactor

import (
	"context"

	"github.com/pkg/errors"
	"gopkg.in/irc.v4"

	"github.com/Luzifer/twitch-bot/v3/pkg/twitch"
	"github.com/Luzifer/twitch-bot/v3/plugins"
)

const actorName = "delete"

var botTwitchClient *twitch.Client

// Register provides the plugins.RegisterFunc
func Register(args plugins.RegistrationArguments) error {
	botTwitchClient = args.GetTwitchClient()

	args.RegisterActor(actorName, func() plugins.Actor { return &actor{} })

	args.RegisterActorDocumentation(plugins.ActionDocumentation{
		Description: "Delete message which caused the rule to be executed",
		Name:        "Delete Message",
		Type:        "delete",
	})

	return nil
}

type actor struct{}

func (actor) Execute(_ *irc.Client, m *irc.Message, _ *plugins.Rule, eventData *plugins.FieldCollection, _ *plugins.FieldCollection) (preventCooldown bool, err error) {
	msgID, ok := m.Tags["id"]
	if !ok || msgID == "" {
		return false, nil
	}

	return false, errors.Wrap(
		botTwitchClient.DeleteMessage(
			context.Background(),
			plugins.DeriveChannel(m, eventData),
			msgID,
		),
		"deleting message",
	)
}

func (actor) IsAsync() bool { return false }
func (actor) Name() string  { return actorName }

func (actor) Validate(plugins.TemplateValidatorFunc, *plugins.FieldCollection) (err error) {
	return nil
}