Search Results for

    Show / Hide Table of Contents

    Class DiscordRestClient

    Provides a client to send REST-based requests to Discord.

    Inheritance
    Object
    BaseDiscordClient
    DiscordRestClient
    DiscordSocketRestClient
    Implements
    IDiscordClient
    IDisposable
    IAsyncDisposable
    Inherited Members
    BaseDiscordClient.Log
    BaseDiscordClient.LoggedIn
    BaseDiscordClient.LoggedOut
    BaseDiscordClient.LoginState
    BaseDiscordClient.TokenType
    BaseDiscordClient.LoginAsync(TokenType, String, Boolean)
    BaseDiscordClient.LogoutAsync()
    BaseDiscordClient.Dispose()
    BaseDiscordClient.DisposeAsync()
    BaseDiscordClient.GetRecommendedShardCountAsync(RequestOptions)
    BaseDiscordClient.GetBotGatewayAsync(RequestOptions)
    BaseDiscordClient.IDiscordClient.ConnectionState
    BaseDiscordClient.IDiscordClient.CurrentUser
    Namespace: Discord.Rest
    Assembly: Discord.Net.Rest.dll
    Syntax
    public class DiscordRestClient : BaseDiscordClient, IDiscordClient, IDisposable, IAsyncDisposable

    Constructors

    | Improve this Doc View Source

    DiscordRestClient()

    Declaration
    public DiscordRestClient()
    | Improve this Doc View Source

    DiscordRestClient(DiscordRestConfig)

    Initializes a new DiscordRestClient with the provided configuration.

    Declaration
    public DiscordRestClient(DiscordRestConfig config)
    Parameters
    Type Name Description
    DiscordRestConfig config

    The configuration to be used with the client.

    Properties

    | Improve this Doc View Source

    CurrentUser

    Gets the logged-in user.

    Declaration
    public RestSelfUser CurrentUser { get; }
    Property Value
    Type Description
    RestSelfUser

    Methods

    | Improve this Doc View Source

    AddReactionAsync(UInt64, UInt64, IEmote, RequestOptions)

    Declaration
    public Task AddReactionAsync(ulong channelId, ulong messageId, IEmote emote, RequestOptions options = null)
    Parameters
    Type Name Description
    UInt64 channelId
    UInt64 messageId
    IEmote emote
    RequestOptions options
    Returns
    Type Description
    Task
    | Improve this Doc View Source

    AddRoleAsync(UInt64, UInt64, UInt64)

    Declaration
    public Task AddRoleAsync(ulong guildId, ulong userId, ulong roleId)
    Parameters
    Type Name Description
    UInt64 guildId
    UInt64 userId
    UInt64 roleId
    Returns
    Type Description
    Task
    | Improve this Doc View Source

    BatchEditGuildCommandPermissions(UInt64, IDictionary<UInt64, ApplicationCommandPermission[]>, RequestOptions)

    Declaration
    public Task<IReadOnlyCollection<GuildApplicationCommandPermission>> BatchEditGuildCommandPermissions(ulong guildId, IDictionary<ulong, ApplicationCommandPermission[]> permissions, RequestOptions options = null)
    Parameters
    Type Name Description
    UInt64 guildId
    IDictionary<UInt64, ApplicationCommandPermission[]> permissions
    RequestOptions options
    Returns
    Type Description
    Task<IReadOnlyCollection<GuildApplicationCommandPermission>>
    | Improve this Doc View Source

    BulkOverwriteGlobalCommands(ApplicationCommandProperties[], RequestOptions)

    Declaration
    public Task<IReadOnlyCollection<RestGlobalCommand>> BulkOverwriteGlobalCommands(ApplicationCommandProperties[] commandProperties, RequestOptions options = null)
    Parameters
    Type Name Description
    ApplicationCommandProperties[] commandProperties
    RequestOptions options
    Returns
    Type Description
    Task<IReadOnlyCollection<RestGlobalCommand>>
    | Improve this Doc View Source

    BulkOverwriteGuildCommands(ApplicationCommandProperties[], UInt64, RequestOptions)

    Declaration
    public Task<IReadOnlyCollection<RestGuildCommand>> BulkOverwriteGuildCommands(ApplicationCommandProperties[] commandProperties, ulong guildId, RequestOptions options = null)
    Parameters
    Type Name Description
    ApplicationCommandProperties[] commandProperties
    UInt64 guildId
    RequestOptions options
    Returns
    Type Description
    Task<IReadOnlyCollection<RestGuildCommand>>
    | Improve this Doc View Source

    CreateGlobalCommand(ApplicationCommandProperties, RequestOptions)

    Declaration
    public Task<RestGlobalCommand> CreateGlobalCommand(ApplicationCommandProperties properties, RequestOptions options = null)
    Parameters
    Type Name Description
    ApplicationCommandProperties properties
    RequestOptions options
    Returns
    Type Description
    Task<RestGlobalCommand>
    | Improve this Doc View Source

    CreateGuildAsync(String, IVoiceRegion, Stream, RequestOptions)

    Declaration
    public Task<RestGuild> CreateGuildAsync(string name, IVoiceRegion region, Stream jpegIcon = null, RequestOptions options = null)
    Parameters
    Type Name Description
    String name
    IVoiceRegion region
    Stream jpegIcon
    RequestOptions options
    Returns
    Type Description
    Task<RestGuild>
    | Improve this Doc View Source

    CreateGuildCommand(ApplicationCommandProperties, UInt64, RequestOptions)

    Declaration
    public Task<RestGuildCommand> CreateGuildCommand(ApplicationCommandProperties properties, ulong guildId, RequestOptions options = null)
    Parameters
    Type Name Description
    ApplicationCommandProperties properties
    UInt64 guildId
    RequestOptions options
    Returns
    Type Description
    Task<RestGuildCommand>
    | Improve this Doc View Source

    DeleteAllGlobalCommandsAsync(RequestOptions)

    Declaration
    public Task DeleteAllGlobalCommandsAsync(RequestOptions options = null)
    Parameters
    Type Name Description
    RequestOptions options
    Returns
    Type Description
    Task
    | Improve this Doc View Source

    GetApplicationInfoAsync(RequestOptions)

    Declaration
    public async Task<RestApplication> GetApplicationInfoAsync(RequestOptions options = null)
    Parameters
    Type Name Description
    RequestOptions options
    Returns
    Type Description
    Task<RestApplication>
    | Improve this Doc View Source

    GetChannelAsync(UInt64, RequestOptions)

    Declaration
    public Task<RestChannel> GetChannelAsync(ulong id, RequestOptions options = null)
    Parameters
    Type Name Description
    UInt64 id
    RequestOptions options
    Returns
    Type Description
    Task<RestChannel>
    | Improve this Doc View Source

    GetConnectionsAsync(RequestOptions)

    Declaration
    public Task<IReadOnlyCollection<RestConnection>> GetConnectionsAsync(RequestOptions options = null)
    Parameters
    Type Name Description
    RequestOptions options
    Returns
    Type Description
    Task<IReadOnlyCollection<RestConnection>>
    | Improve this Doc View Source

    GetDMChannelsAsync(RequestOptions)

    Declaration
    public Task<IReadOnlyCollection<RestDMChannel>> GetDMChannelsAsync(RequestOptions options = null)
    Parameters
    Type Name Description
    RequestOptions options
    Returns
    Type Description
    Task<IReadOnlyCollection<RestDMChannel>>
    | Improve this Doc View Source

    GetGlobalApplicationCommands(Boolean, String, RequestOptions)

    Declaration
    public Task<IReadOnlyCollection<RestGlobalCommand>> GetGlobalApplicationCommands(bool withLocalizations = false, string locale = null, RequestOptions options = null)
    Parameters
    Type Name Description
    Boolean withLocalizations
    String locale
    RequestOptions options
    Returns
    Type Description
    Task<IReadOnlyCollection<RestGlobalCommand>>
    | Improve this Doc View Source

    GetGroupChannelsAsync(RequestOptions)

    Declaration
    public Task<IReadOnlyCollection<RestGroupChannel>> GetGroupChannelsAsync(RequestOptions options = null)
    Parameters
    Type Name Description
    RequestOptions options
    Returns
    Type Description
    Task<IReadOnlyCollection<RestGroupChannel>>
    | Improve this Doc View Source

    GetGuildApplicationCommands(UInt64, Boolean, String, RequestOptions)

    Declaration
    public Task<IReadOnlyCollection<RestGuildCommand>> GetGuildApplicationCommands(ulong guildId, bool withLocalizations = false, string locale = null, RequestOptions options = null)
    Parameters
    Type Name Description
    UInt64 guildId
    Boolean withLocalizations
    String locale
    RequestOptions options
    Returns
    Type Description
    Task<IReadOnlyCollection<RestGuildCommand>>
    | Improve this Doc View Source

    GetGuildAsync(UInt64, RequestOptions)

    Declaration
    public Task<RestGuild> GetGuildAsync(ulong id, RequestOptions options = null)
    Parameters
    Type Name Description
    UInt64 id
    RequestOptions options
    Returns
    Type Description
    Task<RestGuild>
    | Improve this Doc View Source

    GetGuildAsync(UInt64, Boolean, RequestOptions)

    Declaration
    public Task<RestGuild> GetGuildAsync(ulong id, bool withCounts, RequestOptions options = null)
    Parameters
    Type Name Description
    UInt64 id
    Boolean withCounts
    RequestOptions options
    Returns
    Type Description
    Task<RestGuild>
    | Improve this Doc View Source

    GetGuildsAsync(RequestOptions)

    Declaration
    public Task<IReadOnlyCollection<RestGuild>> GetGuildsAsync(RequestOptions options = null)
    Parameters
    Type Name Description
    RequestOptions options
    Returns
    Type Description
    Task<IReadOnlyCollection<RestGuild>>
    | Improve this Doc View Source

    GetGuildsAsync(Boolean, RequestOptions)

    Declaration
    public Task<IReadOnlyCollection<RestGuild>> GetGuildsAsync(bool withCounts, RequestOptions options = null)
    Parameters
    Type Name Description
    Boolean withCounts
    RequestOptions options
    Returns
    Type Description
    Task<IReadOnlyCollection<RestGuild>>
    | Improve this Doc View Source

    GetGuildSummariesAsync(RequestOptions)

    Declaration
    public IAsyncEnumerable<IReadOnlyCollection<RestUserGuild>> GetGuildSummariesAsync(RequestOptions options = null)
    Parameters
    Type Name Description
    RequestOptions options
    Returns
    Type Description
    IAsyncEnumerable<IReadOnlyCollection<RestUserGuild>>
    | Improve this Doc View Source

    GetGuildSummariesAsync(UInt64, Int32, RequestOptions)

    Declaration
    public IAsyncEnumerable<IReadOnlyCollection<RestUserGuild>> GetGuildSummariesAsync(ulong fromGuildId, int limit, RequestOptions options = null)
    Parameters
    Type Name Description
    UInt64 fromGuildId
    Int32 limit
    RequestOptions options
    Returns
    Type Description
    IAsyncEnumerable<IReadOnlyCollection<RestUserGuild>>
    | Improve this Doc View Source

    GetGuildUserAsync(UInt64, UInt64, RequestOptions)

    Declaration
    public Task<RestGuildUser> GetGuildUserAsync(ulong guildId, ulong id, RequestOptions options = null)
    Parameters
    Type Name Description
    UInt64 guildId
    UInt64 id
    RequestOptions options
    Returns
    Type Description
    Task<RestGuildUser>
    | Improve this Doc View Source

    GetGuildWidgetAsync(UInt64, RequestOptions)

    Declaration
    public Task<RestGuildWidget?> GetGuildWidgetAsync(ulong id, RequestOptions options = null)
    Parameters
    Type Name Description
    UInt64 id
    RequestOptions options
    Returns
    Type Description
    Task<Nullable<RestGuildWidget>>
    | Improve this Doc View Source

    GetInviteAsync(String, RequestOptions)

    Declaration
    public Task<RestInviteMetadata> GetInviteAsync(string inviteId, RequestOptions options = null)
    Parameters
    Type Name Description
    String inviteId
    RequestOptions options
    Returns
    Type Description
    Task<RestInviteMetadata>
    | Improve this Doc View Source

    GetPrivateChannelsAsync(RequestOptions)

    Declaration
    public Task<IReadOnlyCollection<IRestPrivateChannel>> GetPrivateChannelsAsync(RequestOptions options = null)
    Parameters
    Type Name Description
    RequestOptions options
    Returns
    Type Description
    Task<IReadOnlyCollection<IRestPrivateChannel>>
    | Improve this Doc View Source

    GetUserAsync(UInt64, RequestOptions)

    Declaration
    public Task<RestUser> GetUserAsync(ulong id, RequestOptions options = null)
    Parameters
    Type Name Description
    UInt64 id
    RequestOptions options
    Returns
    Type Description
    Task<RestUser>
    | Improve this Doc View Source

    GetVoiceRegionAsync(String, RequestOptions)

    Declaration
    public Task<RestVoiceRegion> GetVoiceRegionAsync(string id, RequestOptions options = null)
    Parameters
    Type Name Description
    String id
    RequestOptions options
    Returns
    Type Description
    Task<RestVoiceRegion>
    | Improve this Doc View Source

    GetVoiceRegionsAsync(RequestOptions)

    Declaration
    public Task<IReadOnlyCollection<RestVoiceRegion>> GetVoiceRegionsAsync(RequestOptions options = null)
    Parameters
    Type Name Description
    RequestOptions options
    Returns
    Type Description
    Task<IReadOnlyCollection<RestVoiceRegion>>
    | Improve this Doc View Source

    GetWebhookAsync(UInt64, RequestOptions)

    Declaration
    public Task<RestWebhook> GetWebhookAsync(ulong id, RequestOptions options = null)
    Parameters
    Type Name Description
    UInt64 id
    RequestOptions options
    Returns
    Type Description
    Task<RestWebhook>
    | Improve this Doc View Source

    IsValidHttpInteraction(String, String, String, Byte[])

    Declaration
    public bool IsValidHttpInteraction(string publicKey, string signature, string timestamp, byte[] body)
    Parameters
    Type Name Description
    String publicKey
    String signature
    String timestamp
    Byte[] body
    Returns
    Type Description
    Boolean
    | Improve this Doc View Source

    IsValidHttpInteraction(String, String, String, String)

    Declaration
    public bool IsValidHttpInteraction(string publicKey, string signature, string timestamp, string body)
    Parameters
    Type Name Description
    String publicKey
    String signature
    String timestamp
    String body
    Returns
    Type Description
    Boolean
    | Improve this Doc View Source

    ParseHttpInteractionAsync(String, String, String, Byte[], Func<InteractionProperties, Boolean>)

    Creates a RestInteraction from a http message.

    Declaration
    public async Task<RestInteraction> ParseHttpInteractionAsync(string publicKey, string signature, string timestamp, byte[] body, Func<InteractionProperties, bool> doApiCallOnCreation = null)
    Parameters
    Type Name Description
    String publicKey

    The public key of your application

    String signature

    The signature sent with the interaction.

    String timestamp

    The timestamp sent with the interaction.

    Byte[] body

    The body of the http message.

    Func<InteractionProperties, Boolean> doApiCallOnCreation
    Returns
    Type Description
    Task<RestInteraction>

    A RestInteraction that represents the incoming http interaction.

    Exceptions
    Type Condition
    BadSignatureException

    Thrown when the signature doesn't match the public key.

    | Improve this Doc View Source

    ParseHttpInteractionAsync(String, String, String, String, Func<InteractionProperties, Boolean>)

    Creates a RestInteraction from a http message.

    Declaration
    public Task<RestInteraction> ParseHttpInteractionAsync(string publicKey, string signature, string timestamp, string body, Func<InteractionProperties, bool> doApiCallOnCreation = null)
    Parameters
    Type Name Description
    String publicKey

    The public key of your application

    String signature

    The signature sent with the interaction.

    String timestamp

    The timestamp sent with the interaction.

    String body

    The body of the http message.

    Func<InteractionProperties, Boolean> doApiCallOnCreation
    Returns
    Type Description
    Task<RestInteraction>

    A RestInteraction that represents the incoming http interaction.

    Exceptions
    Type Condition
    BadSignatureException

    Thrown when the signature doesn't match the public key.

    | Improve this Doc View Source

    RemoveAllReactionsAsync(UInt64, UInt64, RequestOptions)

    Declaration
    public Task RemoveAllReactionsAsync(ulong channelId, ulong messageId, RequestOptions options = null)
    Parameters
    Type Name Description
    UInt64 channelId
    UInt64 messageId
    RequestOptions options
    Returns
    Type Description
    Task
    | Improve this Doc View Source

    RemoveAllReactionsForEmoteAsync(UInt64, UInt64, IEmote, RequestOptions)

    Declaration
    public Task RemoveAllReactionsForEmoteAsync(ulong channelId, ulong messageId, IEmote emote, RequestOptions options = null)
    Parameters
    Type Name Description
    UInt64 channelId
    UInt64 messageId
    IEmote emote
    RequestOptions options
    Returns
    Type Description
    Task
    | Improve this Doc View Source

    RemoveReactionAsync(UInt64, UInt64, UInt64, IEmote, RequestOptions)

    Declaration
    public Task RemoveReactionAsync(ulong channelId, ulong messageId, ulong userId, IEmote emote, RequestOptions options = null)
    Parameters
    Type Name Description
    UInt64 channelId
    UInt64 messageId
    UInt64 userId
    IEmote emote
    RequestOptions options
    Returns
    Type Description
    Task
    | Improve this Doc View Source

    RemoveRoleAsync(UInt64, UInt64, UInt64)

    Declaration
    public Task RemoveRoleAsync(ulong guildId, ulong userId, ulong roleId)
    Parameters
    Type Name Description
    UInt64 guildId
    UInt64 userId
    UInt64 roleId
    Returns
    Type Description
    Task

    Implements

    IDiscordClient
    IDisposable
    IAsyncDisposable

    Extension Methods

    ClientExtensions.AddGuildUserAsync(BaseDiscordClient, UInt64, UInt64, String, Action<AddGuildUserProperties>, RequestOptions)

    Theme

    • Improve this Doc
    • View Source
    In This Article
    Back to top Discord.Net (c) 2015-2022 3.9.0