mirror of
https://github.com/JustArchiNET/ArchiSteamFarm.git
synced 2026-01-01 06:00:46 +00:00
47 lines
2.4 KiB
C#
47 lines
2.4 KiB
C#
// ----------------------------------------------------------------------------------------------
|
|
// _ _ _ ____ _ _____
|
|
// / \ _ __ ___ | |__ (_)/ ___| | |_ ___ __ _ _ __ ___ | ___|__ _ _ __ _ __ ___
|
|
// / _ \ | '__|/ __|| '_ \ | |\___ \ | __|/ _ \ / _` || '_ ` _ \ | |_ / _` || '__|| '_ ` _ \
|
|
// / ___ \ | | | (__ | | | || | ___) || |_| __/| (_| || | | | | || _|| (_| || | | | | | | |
|
|
// /_/ \_\|_| \___||_| |_||_||____/ \__|\___| \__,_||_| |_| |_||_| \__,_||_| |_| |_| |_|
|
|
// ----------------------------------------------------------------------------------------------
|
|
// |
|
|
// Copyright 2015-2025 Łukasz "JustArchi" Domeradzki
|
|
// Contact: JustArchi@JustArchi.net
|
|
// |
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// |
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
// |
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
using System.Threading.Tasks;
|
|
using ArchiSteamFarm.Steam;
|
|
using ArchiSteamFarm.Storage;
|
|
using JetBrains.Annotations;
|
|
|
|
namespace ArchiSteamFarm.Plugins.Interfaces;
|
|
|
|
/// <inheritdoc />
|
|
/// <summary>
|
|
/// Implementing this interface allows you to react to each message received on the Steam platform.
|
|
/// </summary>
|
|
/// <remarks>This is used for Steam messages exclusively, that are not ASF commands. If you want to grab the commands, check <see cref="IBotCommand2" /> interface instead.</remarks>
|
|
[PublicAPI]
|
|
public interface IBotMessage : IPlugin {
|
|
/// <summary>
|
|
/// ASF will call this method for messages that are not commands, so ones that do not start from <see cref="GlobalConfig.CommandPrefix" />.
|
|
/// </summary>
|
|
/// <param name="bot">Bot object related to this callback.</param>
|
|
/// <param name="steamID">64-bit long unsigned integer of steamID executing the command.</param>
|
|
/// <param name="message">Message in its raw format.</param>
|
|
/// <returns>Response to the message, or null/empty (as the task value) for silence.</returns>
|
|
public Task<string?> OnBotMessage(Bot bot, ulong steamID, string message);
|
|
}
|