diff --git a/src/Discord.Net.Interactions/Discord.Net.Interactions.xml b/src/Discord.Net.Interactions/Discord.Net.Interactions.xml deleted file mode 100644 index e588d35f0..000000000 --- a/src/Discord.Net.Interactions/Discord.Net.Interactions.xml +++ /dev/null @@ -1,1937 +0,0 @@ - - - - Discord.Net.Interactions - - - - - Set the to . - - - - - Type of the . - - - - - Set the to and define a to handle - Autocomplete interactions targeting the parameter this is applied to. - - - must be set to to use this constructor. - - - - - Set the to without specifying a . - - - - - Specify the target channel types for a option. - - - - - Gets the allowed channel types for this option. - - - - - Specify the target channel types for a option. - - The allowed channel types for this option. - - - - Add a pre-determined argument value to a command parameter. - - - - - Gets the name of the choice. - - - - - Gets the type of this choice. - - - - - Gets the value that will be used whenever this choice is selected. - - - - - Create a parameter choice with type . - - Name of the choice. - Predefined value of the choice. - - - - Create a parameter choice with type . - - Name of the choice. - Predefined value of the choice. - - - - Create a parameter choice with type . - - Name of the choice. - Predefined value of the choice. - - - - Create an Autocomplete Command. - - - - - Gets the name of the target parameter. - - - - - Gets the name of the target command. - - - - - Create a command for Autocomplete interaction handling. - - Name of the target parameter. - Name of the target command. - Set the run mode of the command. - - - - Create a Message Component interaction handler, CustomId represents - the CustomId of the Message Component that will be handled. - - - s will add prefixes to this command if is set to - CustomID supports a Wild Card pattern where you can use the to match a set of CustomIDs. - - - - - Gets the string to compare the Message Component CustomIDs with. - - - - - Gets if s will be ignored while creating this command and this method will be treated as a top level command. - - - - - Create a command for component interaction handling. - - String to compare the Message Component CustomIDs with. - If s will be ignored while creating this command and this method will be treated as a top level command. - Set the run mode of the command. - - - - Base attribute for creating a Context Commands. - - - - - Gets the name of this Context Command. - - - - - Gets the type of this Context Command. - - - - - Create a Message Context Command. - - - s won't add prefixes to this command. - - - - - Register a method as a Message Context Command. - - Name of the context command. - - - - Create an Slash Application Command. - - - prefix will be used to created nested Slash Application Commands. - - - - - Gets the name of the Slash Command. - - - - - Gets the description of the Slash Command. - - - - - Gets if s will be ignored while creating this command and this method will be treated as a top level command. - - - - - Register a method as a Slash Command. - - Name of the command. - Description of the command. - If , s will be ignored while creating this command and this method will be treated as a top level command. - Set the run mode of the command. - - - - Create an User Context Command. - - - s won't add prefixes to this command. - - - - - Register a command as a User Context Command. - - Name of this User Context Command. - - - - Set the "Default Permission" property of an Application Command. - - - - - Whether the users are allowed to use a Slash Command by default or not. - - - - - Set the default permission of a Slash Command. - - if the users are allowed to use this command. - - - - s with this attribute will not be registered by the or - methods. - - - - - Create nested Slash Commands by marking a module as a command group. - - - commands wil not be affected by this. - - - - - Gets the name of the group. - - - - - Gets the description of the group. - - - - - Create a command group. - - Name of the group. - Description of the group. - - - - Set the maximum value permitted for a number type parameter. - - - - - Gets the maximum value permitted. - - - - - Set the maximum value permitted for a number type parameter. - - The maximum value permitted. - - - - Set the minimum value permitted for a number type parameter. - - - - - Gets the minimum value permitted. - - - - - Set the minimum value permitted for a number type parameter. - - The minimum value permitted. - - - - Requires the parameter to pass the specified precondition before execution can begin. - - - - - - Gets the error message to be returned if execution context doesn't pass the precondition check. - - - When overridden in a derived class, uses the supplied string - as the error message if the precondition doesn't pass. - Setting this for a class that doesn't override - this property is a no-op. - - - - - Checks whether the condition is met before execution of the command. - - The context of the command. - The parameter of the command being checked against. - The raw value of the parameter. - The service collection used for dependency injection. - - - - Requires the module or class to pass the specified precondition before execution can begin. - - - - - - Gets the group that this precondition belongs to. - - - of the same group require only one of the preconditions to pass in order to - be successful (A || B). Specifying = null or not at all will - require *all* preconditions to pass, just like normal (A && B). - - - - - Gets the error message to be returned if execution context doesn't pass the precondition check. - - - When overridden in a derived class, uses the supplied string - as the error message if the precondition doesn't pass. - Setting this for a class that doesn't override - this property is a no-op. - - - - - Checks if the command to be executed meets the precondition requirements. - - The context of the command. - The command being executed. - The service collection used for dependency injection. - - - - Customize the name and description of an Slash Application Command parameter. - - - - - Gets the name of the parameter. - - - - - Gets the description of the parameter. - - - - - Modify the default name and description values of a Slash Command parameter. - - Name of the parameter. - Description of the parameter. - - - - Base class for creating Autocompleters. uses Autocompleters to generate parameter suggestions. - - - - - - - - - - - - - - Represent a Autocompleter object that can be executed to generate parameter suggestions. - - - - - Gets the the underlying command service. - - - - - Will be used to generate parameter suggestions. - - Command execution context. - Autocomplete Interaction payload. - Parameter information of the target parameter. - Dependencies that will be used to create the module instance. - - A task representing the execution process. The task result contains the Autocompletion result. - - - - - Executes the with the provided context. - - The execution context. - AutocompleteInteraction payload. - Parameter information of the target parameter. - Dependencies that will be used to create the module instance. - - A task representing the execution process. The task result contains the execution result. - - - - - Represents a Slash Command parameter choice. - - - - - Gets the name of the choice. - - - - - Gets the value of the choice. - - - - - Supported types of pre-defined parameter choices. - - - - - Discord type for . - - - - - Discord type for . - - - - - Discord type for . - - - - - Method body to be executed before executing an application command. - - Command information related to the Discord Application Command. - - - - Method body to be executed after an application command execution. - - Command information related to the Discord Application Command. - - - - Method body to be executed before the derived module is built. - - Command Service instance that built this module. - Info class of this module. - - - - Represents the info class of an attribute based method for handling Autocomplete Interaction events. - - - - - Gets the name of the target parameter. - - - - - Gets the name of the target command. - - - - - - - - - - - - - - - - - - - - Represents a cached method execution delegate. - - Execution context that will be injected into the module class. - Method arguments array. - Service collection for initializing the module. - Command info class of the executed method. - - A task representing the execution operation. - - - - - The base information class for commands. - - The type of that is used by this command type. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Represents the info class of an attribute based method for handling Component Interaction events. - - - - - - - - - - - - - - Execute this command using dependency injection. - - Context that will be injected to the . - Services that will be used while initializing the . - Provide additional string parameters to the method along with the auto generated parameters. - - A task representing the asyncronous command execution process. - - - - - - - - Base information class for attribute based context command handlers. - - - - - - - - - - - - - - - - - - - - - - - Represents the info class of an attribute based method for command type . - - - - - - - - - - - Represents the info class of an attribute based method for command type . - - - - - - - - - - - Represents the info class of an attribute based method for command type . - - - - - Gets the command description that will be displayed on Discord. - - - - - - - - - - - - - - - - - - - - Represents a command that can be registered to Discord. - - - - - Gets the name of this command. - - - - - Gets the type of this command. - - - - - Gets the DefaultPermission of this command. - - - - - Represent a command information object that can be executed. - - - - - Gets the name of the command. - - - - - Gets the name of the command handler method. - - - - - Gets if this command will be registered and executed as a standalone command, unaffected by the s of - of the commands parents. - - - - - Gets wheter this command supports wild card patterns. - - - - - Gets if this command is a top level command and none of its parents have a . - - - - - Gets the module that the method belongs to. - - - - - Gets the the underlying command service. - - - - - Gets a collection of the attributes of this command. - - - - - Gets a collection of the preconditions of this command. - - - - - Gets a collection of the parameters of this command. - - - - - Executes the command with the provided context. - - The execution context - Dependencies that will be used to create the module instance - - A task representing the execution process. The task result contains the execution result. - - - - - Check if an execution context meets the command precondition requirements. - - - - - Represents a parameter. - - - - - Gets the command that this parameter belongs to. - - - - - Gets the name of this parameter. - - - - - Gets the type of this parameter. - - - - - Gets whether this parameter is required. - - - - - Gets whether this parameter is marked with a keyword. - - - - - Gets the default value of this parameter if the parameter is optional. - - - - - Gets a list of the attributes this parameter has. - - - - - Gets a list of the preconditions this parameter has. - - - - - Check if an execution context meets the parameter precondition requirements. - - - - - Contains the information of a Interactions Module. - - - - - Gets the underlying command service. - - - - - Gets the name of this module class. - - - - - Gets the group name of this module, if the module is marked with a . - - - - - Gets if this module is marked with a . - - - - - Gets the description of this module if is . - - - - - Gets the default Permission of this module. - - - - - Gets the collection of Sub Modules of this module. - - - - - Gets the Slash Commands that are declared in this module. - - - - - Gets the Context Commands that are declared in this module. - - - - - Gets the Component Commands that are declared in this module. - - - - - Gets the Autocomplete Commands that are declared in this module. - - - - - Gets the declaring type of this module, if is . - - - - - Gets if this module is declared by another . - - - - - Gets a collection of the attributes of this module. - - - - - Gets a collection of the preconditions of this module. - - - - - Gets if this module has a valid and has no parent with a . - - - - - Gets if this module will not be registered by - or methods. - - - - - Represents the base parameter info class for commands. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Represents the parameter info class for commands. - - - - - - - - Gets the description of the Slash Command Parameter. - - - - - Gets the minimum value permitted for a number type parameter. - - - - - Gets the maxmimum value permitted for a number type parameter. - - - - - Gets the that will be used to convert the incoming into - . - - - - - Gets the Discord option type this parameter represents. - - - - - Gets the parameter choices of this Slash Application Command parameter. - - - - - Gets the allowed channel types for this option. - - - - - Defines the type of error a command can throw. - - - - - Thrown when the command is unknown. - - - - - Thrown when the Slash Command parameter fails to be converted by a TypeReader. - - - - - Thrown when the input text has too few or too many arguments. - - - - - Thrown when an exception occurs mid-command execution. - - - - - Thrown when the command is not successfully executed on runtime. - - - - - Thrown when the command fails to meet a 's conditions. - - - - - Thrown when the command context cannot be parsed by the . - - - - - - - - - - - - - - - - - - - - - - - Provides a base class for a command module to inherit from. - - Type of interaction context to be injected into the module. - - - - Gets the underlying context of the command. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Provides a base class for a command module to inherit from. - - - - - Provides the framework for building and registering Discord Application Commands. - - - - - Occurs when a Slash Command related information is recieved. - - - - - Occurs when a Slash Command is executed. - - - - - Occurs when a Context Command is executed. - - - - - Occurs when a Message Component command is executed. - - - - - Occurs when a Autocomplete command is executed. - - - - - Occurs when a Autocompleter is executed. - - - - - Rest client to be used to register application commands. - - - - - Represents all modules loaded within . - - - - - Represents all Slash Commands loaded within . - - - - - Represents all Context Commands loaded within . - - - - - Represents all Component Commands loaded within . - - - - - Initialize a with provided configurations. - - The discord client. - The configuration class. - - - - Initialize a with provided configurations. - - The discord client. - The configuration class. - - - - Initialize a with provided configurations. - - The discord client. - The configuration class. - - - - Initialize a with provided configurations. - - The discord client. - The configuration class. - - - - - - - - - - - - - Discover and load command modules from an . - - the command modules are defined in. - The for your dependency injection solution if using one; otherwise, pass null. - - A task representing the operation for adding modules. The task result contains a collection of the modules added. - - - - - Add a command module from a . - - Type of the module. - The for your dependency injection solution if using one; otherwise, pass null . - - A task representing the operation for adding the module. The task result contains the built module. - - - Thrown if this module has already been added. - - - Thrown when the is not a valid module definition. - - - - - Add a command module from a . - - Type of the module. - The for your dependency injection solution if using one; otherwise, pass null . - - A task representing the operation for adding the module. The task result contains the built module. - - - Thrown if this module has already been added. - - - Thrown when the is not a valid module definition. - - - - - Register Application Commands from and to a guild. - - Id of the target guild. - If , this operation will not delete the commands that are missing from . - - A task representing the command registration process. The task result contains the active application commands of the target guild. - - - - - Register Application Commands from and to Discord on in global scope. - - If , this operation will not delete the commands that are missing from . - - A task representing the command registration process. The task result contains the active global application commands of bot. - - - - - Register Application Commands from to a guild. - - - Commands will be registered as standalone commands, if you want the to take effect, - use . - - The target guild. - Commands to be registered to Discord. - - A task representing the command registration process. The task result contains the active application commands of the target guild. - - - - - Register Application Commands from modules provided in to a guild. - - The target guild. - Modules to be registered to Discord. - - A task representing the command registration process. The task result contains the active application commands of the target guild. - - - - - Remove a command module. - - The of the module. - - A task that represents the asynchronous removal operation. The task result contains a value that - indicates whether the module is successfully removed. - - - - - Remove a command module. - - The of the module. - - A task that represents the asynchronous removal operation. The task result contains a value that - indicates whether the module is successfully removed. - - - - - Remove a command module. - - The to be removed from the service. - - A task that represents the asynchronous removal operation. The task result contains a value that - indicates whether the is successfully removed. - - - - - Execute a Command from a given . - - Name context of the command. - The service to be used in the command's dependency injection. - - A task representing the command execution process. The task result contains the result of the execution. - - - - - Add a concrete type . - - Primary target of the . - The instance. - - - - Add a concrete type . - - Primary target of the . - The instance. - - - - Add a generic type . - - Generic Type constraint of the of the . - Type of the . - - - - Add a generic type . - - Generic Type constraint of the of the . - Type of the . - - - - Modify the command permissions of the matching Discord Slash Command. - - Module representing the top level Slash Command. - Target guild. - New permission values. - - The active command permissions after the modification. - - - - - Modify the command permissions of the matching Discord Slash Command. - - The Slash Command. - Target guild. - New permission values. - - The active command permissions after the modification. - - - - - Modify the command permissions of the matching Discord Slash Command. - - The Context Command. - Target guild. - New permission values. - - The active command permissions after the modification. - - - - - Get a . - - Declaring module type of this command, must be a type of . - Method name of the handler, use of is recommended. - - instance for this command. - - Module or Slash Command couldn't be found. - - - - Get a . - - Declaring module type of this command, must be a type of . - Method name of the handler, use of is recommended. - - instance for this command. - - Module or Context Command couldn't be found. - - - - Get a . - - Declaring module type of this command, must be a type of . - Method name of the handler, use of is recommended. - - instance for this command. - - Module or Component Command couldn't be found. - - - - Get a built . - - Type of the module, must be a type of . - - instance for this module. - - - - - - - - Represents a configuration class for - - - - - Gets or sets the minimum log level severity that will be sent to the event. - - - - - Gets or sets the default commands should have, if one is not specified on the - Command attribute or builder. - - - - - Gets or sets whether commands should push exceptions up to the caller. - - - - - Gets or sets the delimiters that will be used to seperate group names and the method name when a Message Component Interaction is recieved - - - - - Gets or sets the string expression that will be treated as a wild card - - - - - Delete Slash Command acknowledgements if no Slash Command handler is found in the - - - - - Use compiled lambda expressions to create module instances and execute commands. This method improves performance at the cost of memory - - - - - Allows you to use s - - - Since s are prioritized over s, if s are not used, this should be - disabled to decrease the lookup time - - - - - Gets or sets delegate to be used by the when responding to a Rest based interaction - - - - - Provides a base class for a Rest based command module to inherit from. - - Type of interaction context to be injected into the module - - - - Defer a Rest based Discord Interaction using the delegate - - if the response should be hidden to everyone besides the invoker of the command, otherwise . - The request options for this response. - - A Task representing the operation of creating the interaction response - - Thrown if the interaction isn't a type of - - - - Respond to a Rest based Discord Interaction using the delegate - - The text of the message to be sent. - A array of embeds to send with this response. Max 10. - if the message should be read out by a text-to-speech reader, otherwise . - if the response should be hidden to everyone besides the invoker of the command, otherwise . - The allowed mentions for this response. - The request options for this response. - A to be sent with this response. - A single embed to send with this response. If this is passed alongside an array of embeds, the single embed will be ignored. - - A Task representing the operation of creating the interaction response - - Thrown if the interaction isn't a type of - - - - Contains the information of a Autocomplete Interaction result. - - - - - - - - - - - - - - Get the collection of Autocomplete suggestions to be displayed to the user. - - - - - Initializes a new with no error and without any indicating the command service shouldn't - return any suggestions. - - - A that does not contain any errors. - - - - - Initializes a new with no error. - - Autocomplete suggestions to be displayed to the user - - A that does not contain any errors. - - - - - Initializes a new with a specified result; this may or may not be an - successful execution depending on the and - specified. - - The result to inherit from. - - A that inherits the error type and reason. - - - - - Initializes a new with a specified exception, indicating an unsuccessful - execution. - - The exception that caused the autocomplete process to fail. - - A that contains the exception that caused the unsuccessful execution, along - with a of type as well as the exception message as the - reason. - - - - - Initializes a new with a specified and its - reason, indicating an unsuccessful execution. - - The type of error. - The reason behind the error. - - A that contains a and reason. - - - - - Contains information of the command's overall execution result. - - - - - Gets the exception that may have occurred during the command execution. - - - - - - - - - - - - - - Initializes a new with no error, indicating a successful execution. - - - A that does not contain any errors. - - - - - Initializes a new with a specified and its - reason, indicating an unsuccessful execution. - - The type of error. - The reason behind the error. - - A that contains a and reason. - - - - - Initializes a new with a specified exception, indicating an unsuccessful - execution. - - The exception that caused the command execution to fail. - - A that contains the exception that caused the unsuccessful execution, along - with a of type Exception as well as the exception message as the - reason. - - - - - Initializes a new with a specified result; this may or may not be an - successful execution depending on the and - specified. - - The result to inherit from. - - A that inherits the error type and reason. - - - - - Gets a string that indicates the execution result. - - - Success if is ; otherwise ": - ". - - - - - Contains information of the result related to a command. - - - - - Gets the error type that may have occurred during the operation. - - - A indicating the type of error that may have occurred during the operation; - if the operation was successful. - - - - - Gets the reason for the error. - - - A string containing the error reason. - - - - - Indicates whether the operation was successful or not. - - - if the result is positive; otherwise . - - - - - Represents a result type for grouped command preconditions. - - - - - Gets the results of the preconditions of this group. - - - - - Returns a with no errors. - - - - - Returns a with and the . - - The exception that caused the precondition check to fail. - - - - Returns a with the specified type. - - The result of failure. - - - - Returns a with and the - specified reason. - - The reason of failure. - Precondition results of this group - - - - Represents a result type for command preconditions. - - - - - - - - - - - - - - Initializes a new class with the command type - and reason. - - The type of failure. - The reason of failure. - - - - Returns a with no errors. - - - - - Returns a with and the . - - The exception that caused the precondition check to fail. - - - - Returns a with the specified type. - - The result of failure. - - - - Returns a with and the - specified reason. - - The reason of failure. - - - - - - - - - - - - - Initializes a new class with the type of error and reason. - - The type of failure, or null if none. - The reason of failure. - - - - Represents a result type for . - - - - - Gets the result of the convertion if the operation was successful. - - - - - - - - - - - - - - Returns a with no errors. - - - - - Returns a with and the . - - The exception that caused the type convertion to fail. - - - - Returns a with the specified error and the reason. - - The type of error. - The reason of failure. - - - - Returns a with the specified type. - - The result of failure. - - - - Specifies the behavior of the command execution workflow. - - - - - - Executes the command on the same thread as gateway one. - - - - - Executes the command on a different thread from the gateway one. - - - - - The default behaviour set in . - - - - - Enum values tagged with this attribute will not be displayed as a parameter choice - - - This attributer must be used along with the default - - - - - Base class for creating TypeConverters. uses TypeConverters to interface with Slash Command parameters. - - - - - Will be used to search for alternative TypeConverters whenever the Command Service encounters an unknown parameter type. - - - - - - - Will be used to get the Application Command Option type. - - The option type. - - - - Will be used to read the incoming payload before executing the method body. - - Command exexution context. - Recieved option payload. - Service provider that will be used to initialize the command module. - The result of the read process. - - - - Will be used to manipulate the outgoing command option, before the command gets registered to Discord. - - - - - - - - - - - Wait for an Interaction event for a given amount of time as an asynchronous opration. - - Client that should be listened to for the event. - Timeout duration for this operation. - Delegate for cheking whether an Interaction meets the requirements. - Token for canceling the wait operation. - - A Task representing the asyncronous waiting operation. If the user responded in the given amount of time, Task result contains the user response, - otherwise the Task result is . - - - - - Wait for an Message Component Interaction event for a given amount of time as an asynchronous opration . - - Client that should be listened to for the event. - The message that or should originate from. - Timeout duration for this operation. - Token for canceling the wait operation. - - A Task representing the asyncronous waiting operation with a result, - the result is null if the process timed out before receiving a valid Interaction. - - - - - Create a confirmation dialog and wait for user input asynchronously. - - Client that should be listened to for the event. - Send the confirmation prompt to this channel. - Timeout duration of this operation. - Optional custom prompt message. - Token for canceling the wait operation. - - A Task representing the asyncronous waiting operation with a result, - the result is if the user declined the prompt or didnt answer in time, if the user confirmed the prompt. - - - - - Create a type initializer using compiled lambda expressions - - - - - Get the name of the executed command and its parents in hierarchical order. - - - - The name of the executed command and its parents in hierarchical order. - - - - - Get the name of the executed command and its parents in hierarchical order. - - - - The name of the executed command and its parents in hierarchical order. - - - -