You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
137 lines
8.4 KiB
137 lines
8.4 KiB
4 years ago
|
using System.Collections.Generic;
|
||
|
|
using System.IO;
|
||
|
|
using System.Threading.Tasks;
|
||
|
|
|
||
|
|
namespace Discord.Rest
|
||
|
|
{
|
||
|
|
/// <summary>
|
||
|
|
/// Represents a REST-based channel that can send and receive messages.
|
||
|
|
/// </summary>
|
||
|
|
public interface IRestMessageChannel : IMessageChannel
|
||
|
|
{
|
||
|
|
/// <summary>
|
||
|
|
/// Sends a message to this message channel.
|
||
|
|
/// </summary>
|
||
|
|
/// <remarks>
|
||
|
|
/// This method follows the same behavior as described in <see cref="IMessageChannel.SendMessageAsync"/>.
|
||
|
|
/// Please visit its documentation for more details on this method.
|
||
|
|
/// </remarks>
|
||
|
|
/// <param name="text">The message to be sent.</param>
|
||
|
|
/// <param name="isTTS">Determines whether the message should be read aloud by Discord or not.</param>
|
||
|
|
/// <param name="embed">The <see cref="Discord.EmbedType.Rich"/> <see cref="Embed"/> to be sent.</param>
|
||
|
|
/// <param name="options">The options to be used when sending the request.</param>
|
||
|
|
/// <returns>
|
||
|
|
/// A task that represents an asynchronous send operation for delivering the message. The task result
|
||
|
|
/// contains the sent message.
|
||
|
|
/// </returns>
|
||
|
|
new Task<RestUserMessage> SendMessageAsync(string text = null, bool isTTS = false, Embed embed = null, RequestOptions options = null);
|
||
|
|
/// <summary>
|
||
|
|
/// Sends a file to this message channel with an optional caption.
|
||
|
|
/// </summary>
|
||
|
|
/// <remarks>
|
||
|
|
/// This method follows the same behavior as described in
|
||
|
|
/// <see cref="IMessageChannel.SendFileAsync(string, string, bool, Embed, RequestOptions, bool)"/>. Please visit
|
||
|
|
/// its documentation for more details on this method.
|
||
|
|
/// </remarks>
|
||
|
|
/// <param name="filePath">The file path of the file.</param>
|
||
|
|
/// <param name="text">The message to be sent.</param>
|
||
|
|
/// <param name="isTTS">Whether the message should be read aloud by Discord or not.</param>
|
||
|
|
/// <param name="embed">The <see cref="Discord.EmbedType.Rich" /> <see cref="Embed" /> to be sent.</param>
|
||
|
|
/// <param name="options">The options to be used when sending the request.</param>
|
||
|
|
/// <returns>
|
||
|
|
/// A task that represents an asynchronous send operation for delivering the message. The task result
|
||
|
|
/// contains the sent message.
|
||
|
|
/// </returns>
|
||
|
|
new Task<RestUserMessage> SendFileAsync(string filePath, string text = null, bool isTTS = false, Embed embed = null, RequestOptions options = null, bool isSpoiler = false);
|
||
|
|
/// <summary>
|
||
|
|
/// Sends a file to this message channel with an optional caption.
|
||
|
|
/// </summary>
|
||
|
|
/// <remarks>
|
||
|
|
/// This method follows the same behavior as described in <see cref="IMessageChannel.SendFileAsync(Stream, string, string, bool, Embed, RequestOptions, bool)"/>.
|
||
|
|
/// Please visit its documentation for more details on this method.
|
||
|
|
/// </remarks>
|
||
|
|
/// <param name="stream">The <see cref="Stream" /> of the file to be sent.</param>
|
||
|
|
/// <param name="filename">The name of the attachment.</param>
|
||
|
|
/// <param name="text">The message to be sent.</param>
|
||
|
|
/// <param name="isTTS">Whether the message should be read aloud by Discord or not.</param>
|
||
|
|
/// <param name="embed">The <see cref="Discord.EmbedType.Rich"/> <see cref="Embed"/> to be sent.</param>
|
||
|
|
/// <param name="options">The options to be used when sending the request.</param>
|
||
|
|
/// <returns>
|
||
|
|
/// A task that represents an asynchronous send operation for delivering the message. The task result
|
||
|
|
/// contains the sent message.
|
||
|
|
/// </returns>
|
||
|
|
new Task<RestUserMessage> SendFileAsync(Stream stream, string filename, string text = null, bool isTTS = false, Embed embed = null, RequestOptions options = null, bool isSpoiler = false);
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Gets a message from this message channel.
|
||
|
|
/// </summary>
|
||
|
|
/// <remarks>
|
||
|
|
/// This method follows the same behavior as described in <see cref="IMessageChannel.GetMessageAsync(ulong, CacheMode, RequestOptions)"/>.
|
||
|
|
/// Please visit its documentation for more details on this method.
|
||
|
|
/// </remarks>
|
||
|
|
/// <param name="id">The snowflake identifier of the message.</param>
|
||
|
|
/// <param name="options">The options to be used when sending the request.</param>
|
||
|
|
/// <returns>
|
||
|
|
/// A task that represents an asynchronous get operation for retrieving the message. The task result contains
|
||
|
|
/// the retrieved message; <c>null</c> if no message is found with the specified identifier.
|
||
|
|
/// </returns>
|
||
|
|
Task<RestMessage> GetMessageAsync(ulong id, RequestOptions options = null);
|
||
|
|
/// <summary>
|
||
|
|
/// Gets the last N messages from this message channel.
|
||
|
|
/// </summary>
|
||
|
|
/// <remarks>
|
||
|
|
/// This method follows the same behavior as described in <see cref="IMessageChannel.GetMessagesAsync(int, CacheMode, RequestOptions)"/>.
|
||
|
|
/// Please visit its documentation for more details on this method.
|
||
|
|
/// </remarks>
|
||
|
|
/// <param name="limit">The numbers of message to be gotten from.</param>
|
||
|
|
/// <param name="options">The options to be used when sending the request.</param>
|
||
|
|
/// <returns>
|
||
|
|
/// Paged collection of messages.
|
||
|
|
/// </returns>
|
||
|
|
IAsyncEnumerable<IReadOnlyCollection<RestMessage>> GetMessagesAsync(int limit = DiscordConfig.MaxMessagesPerBatch, RequestOptions options = null);
|
||
|
|
/// <summary>
|
||
|
|
/// Gets a collection of messages in this channel.
|
||
|
|
/// </summary>
|
||
|
|
/// <remarks>
|
||
|
|
/// This method follows the same behavior as described in <see cref="IMessageChannel.GetMessagesAsync(ulong, Direction, int, CacheMode, RequestOptions)"/>.
|
||
|
|
/// Please visit its documentation for more details on this method.
|
||
|
|
/// </remarks>
|
||
|
|
/// <param name="fromMessageId">The ID of the starting message to get the messages from.</param>
|
||
|
|
/// <param name="dir">The direction of the messages to be gotten from.</param>
|
||
|
|
/// <param name="limit">The numbers of message to be gotten from.</param>
|
||
|
|
/// <param name="options">The options to be used when sending the request.</param>
|
||
|
|
/// <returns>
|
||
|
|
/// Paged collection of messages.
|
||
|
|
/// </returns>
|
||
|
|
IAsyncEnumerable<IReadOnlyCollection<RestMessage>> GetMessagesAsync(ulong fromMessageId, Direction dir, int limit = DiscordConfig.MaxMessagesPerBatch, RequestOptions options = null);
|
||
|
|
/// <summary>
|
||
|
|
/// Gets a collection of messages in this channel.
|
||
|
|
/// </summary>
|
||
|
|
/// <remarks>
|
||
|
|
/// This method follows the same behavior as described in <see cref="IMessageChannel.GetMessagesAsync(IMessage, Direction, int, CacheMode, RequestOptions)"/>.
|
||
|
|
/// Please visit its documentation for more details on this method.
|
||
|
|
/// </remarks>
|
||
|
|
/// <param name="fromMessage">The starting message to get the messages from.</param>
|
||
|
|
/// <param name="dir">The direction of the messages to be gotten from.</param>
|
||
|
|
/// <param name="limit">The numbers of message to be gotten from.</param>
|
||
|
|
/// <param name="options">The options to be used when sending the request.</param>
|
||
|
|
/// <returns>
|
||
|
|
/// Paged collection of messages.
|
||
|
|
/// </returns>
|
||
|
|
IAsyncEnumerable<IReadOnlyCollection<RestMessage>> GetMessagesAsync(IMessage fromMessage, Direction dir, int limit = DiscordConfig.MaxMessagesPerBatch, RequestOptions options = null);
|
||
|
|
/// <summary>
|
||
|
|
/// Gets a collection of pinned messages in this channel.
|
||
|
|
/// </summary>
|
||
|
|
/// <remarks>
|
||
|
|
/// This method follows the same behavior as described in <see cref="IMessageChannel.GetPinnedMessagesAsync"/>.
|
||
|
|
/// Please visit its documentation for more details on this method.
|
||
|
|
/// </remarks>
|
||
|
|
/// <param name="options">The options to be used when sending the request.</param>
|
||
|
|
/// <returns>
|
||
|
|
/// A task that represents the asynchronous get operation for retrieving pinned messages in this channel.
|
||
|
|
/// The task result contains a collection of messages found in the pinned messages.
|
||
|
|
/// </returns>
|
||
|
|
new Task<IReadOnlyCollection<RestMessage>> GetPinnedMessagesAsync(RequestOptions options = null);
|
||
|
|
}
|
||
|
|
}
|