You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

Discord.Net.Commands.xml 79 kB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Discord.Net.Commands</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Discord.Commands.AliasAttribute">
  8. <summary>
  9. Marks the aliases for a command.
  10. </summary>
  11. <remarks>
  12. This attribute allows a command to have one or multiple aliases. In other words, the base command can have
  13. multiple aliases when triggering the command itself, giving the end-user more freedom of choices when giving
  14. hot-words to trigger the desired command. See the example for a better illustration.
  15. </remarks>
  16. <example>
  17. In the following example, the command can be triggered with the base name, "stats", or either "stat" or
  18. "info".
  19. <code language="cs">
  20. [Command("stats")]
  21. [Alias("stat", "info")]
  22. public async Task GetStatsAsync(IUser user)
  23. {
  24. // ...pull stats
  25. }
  26. </code>
  27. </example>
  28. </member>
  29. <member name="P:Discord.Commands.AliasAttribute.Aliases">
  30. <summary>
  31. Gets the aliases which have been defined for the command.
  32. </summary>
  33. </member>
  34. <member name="M:Discord.Commands.AliasAttribute.#ctor(System.String[])">
  35. <summary>
  36. Creates a new <see cref="T:Discord.Commands.AliasAttribute" /> with the given aliases.
  37. </summary>
  38. </member>
  39. <member name="T:Discord.Commands.CommandAttribute">
  40. <summary>
  41. Marks the execution information for a command.
  42. </summary>
  43. </member>
  44. <member name="P:Discord.Commands.CommandAttribute.Text">
  45. <summary>
  46. Gets the text that has been set to be recognized as a command.
  47. </summary>
  48. </member>
  49. <member name="P:Discord.Commands.CommandAttribute.RunMode">
  50. <summary>
  51. Specifies the <see cref="P:Discord.Commands.CommandAttribute.RunMode" /> of the command. This affects how the command is executed.
  52. </summary>
  53. </member>
  54. <member name="M:Discord.Commands.CommandAttribute.#ctor">
  55. <inheritdoc />
  56. </member>
  57. <member name="M:Discord.Commands.CommandAttribute.#ctor(System.String)">
  58. <summary>
  59. Initializes a new <see cref="T:Discord.Commands.CommandAttribute" /> attribute with the specified name.
  60. </summary>
  61. <param name="text">The name of the command.</param>
  62. </member>
  63. <member name="T:Discord.Commands.DontAutoLoadAttribute">
  64. <summary>
  65. Prevents the marked module from being loaded automatically.
  66. </summary>
  67. <remarks>
  68. This attribute tells <see cref="T:Discord.Commands.CommandService" /> to ignore the marked module from being loaded
  69. automatically (e.g. the <see cref="M:Discord.Commands.CommandService.AddModulesAsync(System.Reflection.Assembly,System.IServiceProvider)" /> method). If a non-public module marked
  70. with this attribute is attempted to be loaded manually, the loading process will also fail.
  71. </remarks>
  72. </member>
  73. <member name="T:Discord.Commands.DontInjectAttribute">
  74. <summary>
  75. Prevents the marked property from being injected into a module.
  76. </summary>
  77. <remarks>
  78. This attribute prevents the marked member from being injected into its parent module. Useful when you have a
  79. public property that you do not wish to invoke the library's dependency injection service.
  80. </remarks>
  81. <example>
  82. In the following example, <c>DatabaseService</c> will not be automatically injected into the module and will
  83. not throw an error message if the dependency fails to be resolved.
  84. <code language="cs">
  85. public class MyModule : ModuleBase
  86. {
  87. [DontInject]
  88. public DatabaseService DatabaseService;
  89. public MyModule()
  90. {
  91. DatabaseService = DatabaseFactory.Generate();
  92. }
  93. }
  94. </code>
  95. </example>
  96. </member>
  97. <member name="T:Discord.Commands.GroupAttribute">
  98. <summary>
  99. Marks the module as a command group.
  100. </summary>
  101. </member>
  102. <member name="P:Discord.Commands.GroupAttribute.Prefix">
  103. <summary>
  104. Gets the prefix set for the module.
  105. </summary>
  106. </member>
  107. <member name="M:Discord.Commands.GroupAttribute.#ctor">
  108. <inheritdoc />
  109. </member>
  110. <member name="M:Discord.Commands.GroupAttribute.#ctor(System.String)">
  111. <summary>
  112. Initializes a new <see cref="T:Discord.Commands.GroupAttribute" /> with the provided prefix.
  113. </summary>
  114. <param name="prefix">The prefix of the module group.</param>
  115. </member>
  116. <member name="T:Discord.Commands.NameAttribute">
  117. <summary>
  118. Marks the public name of a command, module, or parameter.
  119. </summary>
  120. </member>
  121. <member name="P:Discord.Commands.NameAttribute.Text">
  122. <summary>
  123. Gets the name of the command.
  124. </summary>
  125. </member>
  126. <member name="M:Discord.Commands.NameAttribute.#ctor(System.String)">
  127. <summary>
  128. Marks the public name of a command, module, or parameter with the provided name.
  129. </summary>
  130. <param name="text">The public name of the object.</param>
  131. </member>
  132. <member name="T:Discord.Commands.NamedArgumentTypeAttribute">
  133. <summary>
  134. Instructs the command system to treat command parameters of this type
  135. as a collection of named arguments matching to its properties.
  136. </summary>
  137. </member>
  138. <member name="T:Discord.Commands.OverrideTypeReaderAttribute">
  139. <summary>
  140. Marks the <see cref="T:System.Type"/> to be read by the specified <see cref="T:Discord.Commands.TypeReader"/>.
  141. </summary>
  142. <remarks>
  143. This attribute will override the <see cref="T:Discord.Commands.TypeReader"/> to be used when parsing for the
  144. desired type in the command. This is useful when one wishes to use a particular
  145. <see cref="T:Discord.Commands.TypeReader"/> without affecting other commands that are using the same target
  146. type.
  147. <note type="warning">
  148. If the given type reader does not inherit from <see cref="T:Discord.Commands.TypeReader"/>, an
  149. <see cref="T:System.ArgumentException"/> will be thrown.
  150. </note>
  151. </remarks>
  152. <example>
  153. In this example, the <see cref="T:System.TimeSpan"/> will be read by a custom
  154. <see cref="T:Discord.Commands.TypeReader"/>, <c>FriendlyTimeSpanTypeReader</c>, instead of the
  155. <see cref="T:Discord.Commands.TimeSpanTypeReader"/> shipped by Discord.Net.
  156. <code language="cs">
  157. [Command("time")]
  158. public Task GetTimeAsync([OverrideTypeReader(typeof(FriendlyTimeSpanTypeReader))]TimeSpan time)
  159. => ReplyAsync(time);
  160. </code>
  161. </example>
  162. </member>
  163. <member name="P:Discord.Commands.OverrideTypeReaderAttribute.TypeReader">
  164. <summary>
  165. Gets the specified <see cref="P:Discord.Commands.OverrideTypeReaderAttribute.TypeReader"/> of the parameter.
  166. </summary>
  167. </member>
  168. <member name="M:Discord.Commands.OverrideTypeReaderAttribute.#ctor(System.Type)">
  169. <inheritdoc/>
  170. <param name="overridenTypeReader">The <see cref="P:Discord.Commands.OverrideTypeReaderAttribute.TypeReader"/> to be used with the parameter. </param>
  171. <exception cref="T:System.ArgumentException">The given <paramref name="overridenTypeReader"/> does not inherit from <see cref="P:Discord.Commands.OverrideTypeReaderAttribute.TypeReader"/>.</exception>
  172. </member>
  173. <member name="T:Discord.Commands.ParameterPreconditionAttribute">
  174. <summary>
  175. Requires the parameter to pass the specified precondition before execution can begin.
  176. </summary>
  177. <seealso cref="T:Discord.Commands.PreconditionAttribute"/>
  178. </member>
  179. <member name="M:Discord.Commands.ParameterPreconditionAttribute.CheckPermissionsAsync(Discord.Commands.ICommandContext,Discord.Commands.ParameterInfo,System.Object,System.IServiceProvider)">
  180. <summary>
  181. Checks whether the condition is met before execution of the command.
  182. </summary>
  183. <param name="context">The context of the command.</param>
  184. <param name="parameter">The parameter of the command being checked against.</param>
  185. <param name="value">The raw value of the parameter.</param>
  186. <param name="services">The service collection used for dependency injection.</param>
  187. </member>
  188. <member name="T:Discord.Commands.PreconditionAttribute">
  189. <summary>
  190. Requires the module or class to pass the specified precondition before execution can begin.
  191. </summary>
  192. <seealso cref="T:Discord.Commands.ParameterPreconditionAttribute"/>
  193. </member>
  194. <member name="P:Discord.Commands.PreconditionAttribute.Group">
  195. <summary>
  196. Specifies a group that this precondition belongs to.
  197. </summary>
  198. <remarks>
  199. <see cref="T:Discord.Preconditions" /> of the same group require only one of the preconditions to pass in order to
  200. be successful (A || B). Specifying <see cref="P:Discord.Commands.PreconditionAttribute.Group" /> = <c>null</c> or not at all will
  201. require *all* preconditions to pass, just like normal (A &amp;&amp; B).
  202. </remarks>
  203. </member>
  204. <member name="P:Discord.Commands.PreconditionAttribute.ErrorMessage">
  205. <summary>
  206. When overridden in a derived class, uses the supplied string
  207. as the error message if the precondition doesn't pass.
  208. Setting this for a class that doesn't override
  209. this property is a no-op.
  210. </summary>
  211. </member>
  212. <member name="M:Discord.Commands.PreconditionAttribute.CheckPermissionsAsync(Discord.Commands.ICommandContext,Discord.Commands.CommandInfo,System.IServiceProvider)">
  213. <summary>
  214. Checks if the <paramref name="command"/> has the sufficient permission to be executed.
  215. </summary>
  216. <param name="context">The context of the command.</param>
  217. <param name="command">The command being executed.</param>
  218. <param name="services">The service collection used for dependency injection.</param>
  219. </member>
  220. <member name="T:Discord.Commands.RequireBotPermissionAttribute">
  221. <summary>
  222. Requires the bot to have a specific permission in the channel a command is invoked in.
  223. </summary>
  224. </member>
  225. <member name="P:Discord.Commands.RequireBotPermissionAttribute.GuildPermission">
  226. <summary>
  227. Gets the specified <see cref="T:Discord.GuildPermission" /> of the precondition.
  228. </summary>
  229. </member>
  230. <member name="P:Discord.Commands.RequireBotPermissionAttribute.ChannelPermission">
  231. <summary>
  232. Gets the specified <see cref="T:Discord.ChannelPermission" /> of the precondition.
  233. </summary>
  234. </member>
  235. <member name="P:Discord.Commands.RequireBotPermissionAttribute.ErrorMessage">
  236. <inheritdoc />
  237. </member>
  238. <member name="P:Discord.Commands.RequireBotPermissionAttribute.NotAGuildErrorMessage">
  239. <summary>
  240. Gets or sets the error message if the precondition
  241. fails due to being run outside of a Guild channel.
  242. </summary>
  243. </member>
  244. <member name="M:Discord.Commands.RequireBotPermissionAttribute.#ctor(Discord.GuildPermission)">
  245. <summary>
  246. Requires the bot account to have a specific <see cref="T:Discord.GuildPermission"/>.
  247. </summary>
  248. <remarks>
  249. This precondition will always fail if the command is being invoked in a <see cref="T:Discord.IPrivateChannel"/>.
  250. </remarks>
  251. <param name="permission">
  252. The <see cref="T:Discord.GuildPermission"/> that the bot must have. Multiple permissions can be specified
  253. by ORing the permissions together.
  254. </param>
  255. </member>
  256. <member name="M:Discord.Commands.RequireBotPermissionAttribute.#ctor(Discord.ChannelPermission)">
  257. <summary>
  258. Requires that the bot account to have a specific <see cref="T:Discord.ChannelPermission"/>.
  259. </summary>
  260. <param name="permission">
  261. The <see cref="T:Discord.ChannelPermission"/> that the bot must have. Multiple permissions can be
  262. specified by ORing the permissions together.
  263. </param>
  264. </member>
  265. <member name="M:Discord.Commands.RequireBotPermissionAttribute.CheckPermissionsAsync(Discord.Commands.ICommandContext,Discord.Commands.CommandInfo,System.IServiceProvider)">
  266. <inheritdoc />
  267. </member>
  268. <member name="T:Discord.Commands.ContextType">
  269. <summary>
  270. Defines the type of command context (i.e. where the command is being executed).
  271. </summary>
  272. </member>
  273. <member name="F:Discord.Commands.ContextType.Guild">
  274. <summary>
  275. Specifies the command to be executed within a guild.
  276. </summary>
  277. </member>
  278. <member name="F:Discord.Commands.ContextType.DM">
  279. <summary>
  280. Specifies the command to be executed within a DM.
  281. </summary>
  282. </member>
  283. <member name="F:Discord.Commands.ContextType.Group">
  284. <summary>
  285. Specifies the command to be executed within a group.
  286. </summary>
  287. </member>
  288. <member name="T:Discord.Commands.RequireContextAttribute">
  289. <summary>
  290. Requires the command to be invoked in a specified context (e.g. in guild, DM).
  291. </summary>
  292. </member>
  293. <member name="P:Discord.Commands.RequireContextAttribute.Contexts">
  294. <summary>
  295. Gets the context required to execute the command.
  296. </summary>
  297. </member>
  298. <member name="P:Discord.Commands.RequireContextAttribute.ErrorMessage">
  299. <inheritdoc />
  300. </member>
  301. <member name="M:Discord.Commands.RequireContextAttribute.#ctor(Discord.Commands.ContextType)">
  302. <summary> Requires the command to be invoked in the specified context. </summary>
  303. <param name="contexts">The type of context the command can be invoked in. Multiple contexts can be specified by ORing the contexts together.</param>
  304. <example>
  305. <code language="cs">
  306. [Command("secret")]
  307. [RequireContext(ContextType.DM | ContextType.Group)]
  308. public Task PrivateOnlyAsync()
  309. {
  310. return ReplyAsync("shh, this command is a secret");
  311. }
  312. </code>
  313. </example>
  314. </member>
  315. <member name="M:Discord.Commands.RequireContextAttribute.CheckPermissionsAsync(Discord.Commands.ICommandContext,Discord.Commands.CommandInfo,System.IServiceProvider)">
  316. <inheritdoc />
  317. </member>
  318. <member name="T:Discord.Commands.RequireNsfwAttribute">
  319. <summary>
  320. Requires the command to be invoked in a channel marked NSFW.
  321. </summary>
  322. <remarks>
  323. The precondition will restrict the access of the command or module to be accessed within a guild channel
  324. that has been marked as mature or NSFW. If the channel is not of type <see cref="T:Discord.ITextChannel"/> or the
  325. channel is not marked as NSFW, the precondition will fail with an erroneous <see cref="T:Discord.Commands.PreconditionResult"/>.
  326. </remarks>
  327. <example>
  328. The following example restricts the command <c>too-cool</c> to an NSFW-enabled channel only.
  329. <code language="cs">
  330. public class DankModule : ModuleBase
  331. {
  332. [Command("cool")]
  333. public Task CoolAsync()
  334. => ReplyAsync("I'm cool for everyone.");
  335. [RequireNsfw]
  336. [Command("too-cool")]
  337. public Task TooCoolAsync()
  338. => ReplyAsync("You can only see this if you're cool enough.");
  339. }
  340. </code>
  341. </example>
  342. </member>
  343. <member name="P:Discord.Commands.RequireNsfwAttribute.ErrorMessage">
  344. <inheritdoc />
  345. </member>
  346. <member name="M:Discord.Commands.RequireNsfwAttribute.CheckPermissionsAsync(Discord.Commands.ICommandContext,Discord.Commands.CommandInfo,System.IServiceProvider)">
  347. <inheritdoc />
  348. </member>
  349. <member name="T:Discord.Commands.RequireOwnerAttribute">
  350. <summary>
  351. Requires the command to be invoked by the owner of the bot.
  352. </summary>
  353. <remarks>
  354. This precondition will restrict the access of the command or module to the owner of the Discord application.
  355. If the precondition fails to be met, an erroneous <see cref="T:Discord.Commands.PreconditionResult"/> will be returned with the
  356. message "Command can only be run by the owner of the bot."
  357. <note>
  358. This precondition will only work if the account has a <see cref="T:Discord.TokenType"/> of <see cref="F:Discord.TokenType.Bot"/>
  359. ;otherwise, this precondition will always fail.
  360. </note>
  361. </remarks>
  362. <example>
  363. The following example restricts the command to a set of sensitive commands that only the owner of the bot
  364. application should be able to access.
  365. <code language="cs">
  366. [RequireOwner]
  367. [Group("admin")]
  368. public class AdminModule : ModuleBase
  369. {
  370. [Command("exit")]
  371. public async Task ExitAsync()
  372. {
  373. Environment.Exit(0);
  374. }
  375. }
  376. </code>
  377. </example>
  378. </member>
  379. <member name="P:Discord.Commands.RequireOwnerAttribute.ErrorMessage">
  380. <inheritdoc />
  381. </member>
  382. <member name="M:Discord.Commands.RequireOwnerAttribute.CheckPermissionsAsync(Discord.Commands.ICommandContext,Discord.Commands.CommandInfo,System.IServiceProvider)">
  383. <inheritdoc />
  384. </member>
  385. <member name="T:Discord.Commands.RequireUserPermissionAttribute">
  386. <summary>
  387. Requires the user invoking the command to have a specified permission.
  388. </summary>
  389. </member>
  390. <member name="P:Discord.Commands.RequireUserPermissionAttribute.GuildPermission">
  391. <summary>
  392. Gets the specified <see cref="T:Discord.GuildPermission" /> of the precondition.
  393. </summary>
  394. </member>
  395. <member name="P:Discord.Commands.RequireUserPermissionAttribute.ChannelPermission">
  396. <summary>
  397. Gets the specified <see cref="T:Discord.ChannelPermission" /> of the precondition.
  398. </summary>
  399. </member>
  400. <member name="P:Discord.Commands.RequireUserPermissionAttribute.ErrorMessage">
  401. <inheritdoc />
  402. </member>
  403. <member name="P:Discord.Commands.RequireUserPermissionAttribute.NotAGuildErrorMessage">
  404. <summary>
  405. Gets or sets the error message if the precondition
  406. fails due to being run outside of a Guild channel.
  407. </summary>
  408. </member>
  409. <member name="M:Discord.Commands.RequireUserPermissionAttribute.#ctor(Discord.GuildPermission)">
  410. <summary>
  411. Requires that the user invoking the command to have a specific <see cref="T:Discord.GuildPermission"/>.
  412. </summary>
  413. <remarks>
  414. This precondition will always fail if the command is being invoked in a <see cref="T:Discord.IPrivateChannel"/>.
  415. </remarks>
  416. <param name="permission">
  417. The <see cref="T:Discord.GuildPermission" /> that the user must have. Multiple permissions can be
  418. specified by ORing the permissions together.
  419. </param>
  420. </member>
  421. <member name="M:Discord.Commands.RequireUserPermissionAttribute.#ctor(Discord.ChannelPermission)">
  422. <summary>
  423. Requires that the user invoking the command to have a specific <see cref="T:Discord.ChannelPermission"/>.
  424. </summary>
  425. <param name="permission">
  426. The <see cref="T:Discord.ChannelPermission"/> that the user must have. Multiple permissions can be
  427. specified by ORing the permissions together.
  428. </param>
  429. </member>
  430. <member name="M:Discord.Commands.RequireUserPermissionAttribute.CheckPermissionsAsync(Discord.Commands.ICommandContext,Discord.Commands.CommandInfo,System.IServiceProvider)">
  431. <inheritdoc />
  432. </member>
  433. <member name="T:Discord.Commands.PriorityAttribute">
  434. <summary>
  435. Sets priority of commands.
  436. </summary>
  437. </member>
  438. <member name="P:Discord.Commands.PriorityAttribute.Priority">
  439. <summary>
  440. Gets the priority which has been set for the command.
  441. </summary>
  442. </member>
  443. <member name="M:Discord.Commands.PriorityAttribute.#ctor(System.Int32)">
  444. <summary>
  445. Initializes a new <see cref="T:Discord.Commands.PriorityAttribute" /> attribute with the given priority.
  446. </summary>
  447. </member>
  448. <member name="T:Discord.Commands.RemainderAttribute">
  449. <summary>
  450. Marks the input to not be parsed by the parser.
  451. </summary>
  452. </member>
  453. <member name="T:Discord.Commands.RemarksAttribute">
  454. <summary>
  455. Attaches remarks to your commands.
  456. </summary>
  457. </member>
  458. <member name="T:Discord.Commands.SummaryAttribute">
  459. <summary>
  460. Attaches a summary to your command.
  461. </summary>
  462. </member>
  463. <member name="M:Discord.Commands.Builders.CommandBuilder.Build(Discord.Commands.ModuleInfo,Discord.Commands.CommandService)">
  464. <exception cref="T:System.InvalidOperationException">Only the last parameter in a command may have the Remainder or Multiple flag.</exception>
  465. </member>
  466. <member name="T:Discord.Commands.CommandContext">
  467. <summary> The context of a command which may contain the client, user, guild, channel, and message. </summary>
  468. </member>
  469. <member name="P:Discord.Commands.CommandContext.Client">
  470. <inheritdoc/>
  471. </member>
  472. <member name="P:Discord.Commands.CommandContext.Guild">
  473. <inheritdoc/>
  474. </member>
  475. <member name="P:Discord.Commands.CommandContext.Channel">
  476. <inheritdoc/>
  477. </member>
  478. <member name="P:Discord.Commands.CommandContext.User">
  479. <inheritdoc/>
  480. </member>
  481. <member name="P:Discord.Commands.CommandContext.Message">
  482. <inheritdoc/>
  483. </member>
  484. <member name="P:Discord.Commands.CommandContext.IsPrivate">
  485. <summary> Indicates whether the channel that the command is executed in is a private channel. </summary>
  486. </member>
  487. <member name="M:Discord.Commands.CommandContext.#ctor(Discord.IDiscordClient,Discord.IUserMessage)">
  488. <summary>
  489. Initializes a new <see cref="T:Discord.Commands.CommandContext" /> class with the provided client and message.
  490. </summary>
  491. <param name="client">The underlying client.</param>
  492. <param name="msg">The underlying message.</param>
  493. </member>
  494. <member name="T:Discord.Commands.CommandError">
  495. <summary> Defines the type of error a command can throw. </summary>
  496. </member>
  497. <member name="F:Discord.Commands.CommandError.UnknownCommand">
  498. <summary>
  499. Thrown when the command is unknown.
  500. </summary>
  501. </member>
  502. <member name="F:Discord.Commands.CommandError.ParseFailed">
  503. <summary>
  504. Thrown when the command fails to be parsed.
  505. </summary>
  506. </member>
  507. <member name="F:Discord.Commands.CommandError.BadArgCount">
  508. <summary>
  509. Thrown when the input text has too few or too many arguments.
  510. </summary>
  511. </member>
  512. <member name="F:Discord.Commands.CommandError.ObjectNotFound">
  513. <summary>
  514. Thrown when the object cannot be found by the <see cref="T:Discord.Commands.TypeReader"/>.
  515. </summary>
  516. </member>
  517. <member name="F:Discord.Commands.CommandError.MultipleMatches">
  518. <summary>
  519. Thrown when more than one object is matched by <see cref="T:Discord.Commands.TypeReader"/>.
  520. </summary>
  521. </member>
  522. <member name="F:Discord.Commands.CommandError.UnmetPrecondition">
  523. <summary>
  524. Thrown when the command fails to meet a <see cref="T:Discord.Commands.PreconditionAttribute"/>'s conditions.
  525. </summary>
  526. </member>
  527. <member name="F:Discord.Commands.CommandError.Exception">
  528. <summary>
  529. Thrown when an exception occurs mid-command execution.
  530. </summary>
  531. </member>
  532. <member name="F:Discord.Commands.CommandError.Unsuccessful">
  533. <summary>
  534. Thrown when the command is not successfully executed on runtime.
  535. </summary>
  536. </member>
  537. <member name="T:Discord.Commands.CommandException">
  538. <summary>
  539. The exception that is thrown if another exception occurs during a command execution.
  540. </summary>
  541. </member>
  542. <member name="P:Discord.Commands.CommandException.Command">
  543. <summary> Gets the command that caused the exception. </summary>
  544. </member>
  545. <member name="P:Discord.Commands.CommandException.Context">
  546. <summary> Gets the command context of the exception. </summary>
  547. </member>
  548. <member name="M:Discord.Commands.CommandException.#ctor(Discord.Commands.CommandInfo,Discord.Commands.ICommandContext,System.Exception)">
  549. <summary>
  550. Initializes a new instance of the <see cref="T:Discord.Commands.CommandException" /> class using a
  551. <paramref name="command"/> information, a <paramref name="command"/> context, and the exception that
  552. interrupted the execution.
  553. </summary>
  554. <param name="command">The command information.</param>
  555. <param name="context">The context of the command.</param>
  556. <param name="ex">The exception that interrupted the command execution.</param>
  557. </member>
  558. <member name="P:Discord.Commands.CommandMatch.Command">
  559. <summary> The command that matches the search result. </summary>
  560. </member>
  561. <member name="P:Discord.Commands.CommandMatch.Alias">
  562. <summary> The alias of the command. </summary>
  563. </member>
  564. <member name="T:Discord.Commands.CommandService">
  565. <summary>
  566. Provides a framework for building Discord commands.
  567. </summary>
  568. <remarks>
  569. <para>
  570. The service provides a framework for building Discord commands both dynamically via runtime builders or
  571. statically via compile-time modules. To create a command module at compile-time, see
  572. <see cref="T:Discord.Commands.ModuleBase" /> (most common); otherwise, see <see cref="T:Discord.Commands.Builders.ModuleBuilder" />.
  573. </para>
  574. <para>
  575. This service also provides several events for monitoring command usages; such as
  576. <see cref="E:Discord.Commands.CommandService.Log" /> for any command-related log events, and
  577. <see cref="E:Discord.Commands.CommandService.CommandExecuted" /> for information about commands that have
  578. been successfully executed.
  579. </para>
  580. </remarks>
  581. </member>
  582. <member name="E:Discord.Commands.CommandService.Log">
  583. <summary>
  584. Occurs when a command-related information is received.
  585. </summary>
  586. </member>
  587. <member name="E:Discord.Commands.CommandService.CommandExecuted">
  588. <summary>
  589. Occurs when a command is executed.
  590. </summary>
  591. <remarks>
  592. This event is fired when a command has been executed, successfully or not. When a command fails to
  593. execute during parsing or precondition stage, the CommandInfo may not be returned.
  594. </remarks>
  595. </member>
  596. <member name="P:Discord.Commands.CommandService.Modules">
  597. <summary>
  598. Represents all modules loaded within <see cref="T:Discord.Commands.CommandService"/>.
  599. </summary>
  600. </member>
  601. <member name="P:Discord.Commands.CommandService.Commands">
  602. <summary>
  603. Represents all commands loaded within <see cref="T:Discord.Commands.CommandService"/>.
  604. </summary>
  605. </member>
  606. <member name="P:Discord.Commands.CommandService.TypeReaders">
  607. <summary>
  608. Represents all <see cref="T:Discord.Commands.TypeReader" /> loaded within <see cref="T:Discord.Commands.CommandService"/>.
  609. </summary>
  610. </member>
  611. <member name="M:Discord.Commands.CommandService.#ctor">
  612. <summary>
  613. Initializes a new <see cref="T:Discord.Commands.CommandService"/> class.
  614. </summary>
  615. </member>
  616. <member name="M:Discord.Commands.CommandService.#ctor(Discord.Commands.CommandServiceConfig)">
  617. <summary>
  618. Initializes a new <see cref="T:Discord.Commands.CommandService"/> class with the provided configuration.
  619. </summary>
  620. <param name="config">The configuration class.</param>
  621. <exception cref="T:System.InvalidOperationException">
  622. The <see cref="T:Discord.Commands.RunMode"/> cannot be set to <see cref="F:Discord.Commands.RunMode.Default"/>.
  623. </exception>
  624. </member>
  625. <member name="M:Discord.Commands.CommandService.AddModuleAsync``1(System.IServiceProvider)">
  626. <summary>
  627. Add a command module from a <see cref="T:System.Type" />.
  628. </summary>
  629. <example>
  630. <para>The following example registers the module <c>MyModule</c> to <c>commandService</c>.</para>
  631. <code language="cs">
  632. await commandService.AddModuleAsync&lt;MyModule&gt;(serviceProvider);
  633. </code>
  634. </example>
  635. <typeparam name="T">The type of module.</typeparam>
  636. <param name="services">The <see cref="T:System.IServiceProvider"/> for your dependency injection solution if using one; otherwise, pass <c>null</c>.</param>
  637. <exception cref="T:System.ArgumentException">This module has already been added.</exception>
  638. <exception cref="T:System.InvalidOperationException">
  639. The <see cref="T:Discord.Commands.ModuleInfo"/> fails to be built; an invalid type may have been provided.
  640. </exception>
  641. <returns>
  642. A task that represents the asynchronous operation for adding the module. The task result contains the
  643. built module.
  644. </returns>
  645. </member>
  646. <member name="M:Discord.Commands.CommandService.AddModuleAsync(System.Type,System.IServiceProvider)">
  647. <summary>
  648. Adds a command module from a <see cref="T:System.Type" />.
  649. </summary>
  650. <param name="type">The type of module.</param>
  651. <param name="services">The <see cref="T:System.IServiceProvider" /> for your dependency injection solution if using one; otherwise, pass <c>null</c> .</param>
  652. <exception cref="T:System.ArgumentException">This module has already been added.</exception>
  653. <exception cref="T:System.InvalidOperationException">
  654. The <see cref="T:Discord.Commands.ModuleInfo"/> fails to be built; an invalid type may have been provided.
  655. </exception>
  656. <returns>
  657. A task that represents the asynchronous operation for adding the module. The task result contains the
  658. built module.
  659. </returns>
  660. </member>
  661. <member name="M:Discord.Commands.CommandService.AddModulesAsync(System.Reflection.Assembly,System.IServiceProvider)">
  662. <summary>
  663. Add command modules from an <see cref="T:System.Reflection.Assembly"/>.
  664. </summary>
  665. <param name="assembly">The <see cref="T:System.Reflection.Assembly"/> containing command modules.</param>
  666. <param name="services">The <see cref="T:System.IServiceProvider"/> for your dependency injection solution if using one; otherwise, pass <c>null</c>.</param>
  667. <returns>
  668. A task that represents the asynchronous operation for adding the command modules. The task result
  669. contains an enumerable collection of modules added.
  670. </returns>
  671. </member>
  672. <member name="M:Discord.Commands.CommandService.RemoveModuleAsync(Discord.Commands.ModuleInfo)">
  673. <summary>
  674. Removes the command module.
  675. </summary>
  676. <param name="module">The <see cref="T:Discord.Commands.ModuleInfo" /> to be removed from the service.</param>
  677. <returns>
  678. A task that represents the asynchronous removal operation. The task result contains a value that
  679. indicates whether the <paramref name="module"/> is successfully removed.
  680. </returns>
  681. </member>
  682. <member name="M:Discord.Commands.CommandService.RemoveModuleAsync``1">
  683. <summary>
  684. Removes the command module.
  685. </summary>
  686. <typeparam name="T">The <see cref="T:System.Type"/> of the module.</typeparam>
  687. <returns>
  688. A task that represents the asynchronous removal operation. The task result contains a value that
  689. indicates whether the module is successfully removed.
  690. </returns>
  691. </member>
  692. <member name="M:Discord.Commands.CommandService.RemoveModuleAsync(System.Type)">
  693. <summary>
  694. Removes the command module.
  695. </summary>
  696. <param name="type">The <see cref="T:System.Type"/> of the module.</param>
  697. <returns>
  698. A task that represents the asynchronous removal operation. The task result contains a value that
  699. indicates whether the module is successfully removed.
  700. </returns>
  701. </member>
  702. <member name="M:Discord.Commands.CommandService.AddTypeReader``1(Discord.Commands.TypeReader)">
  703. <summary>
  704. Adds a custom <see cref="T:Discord.Commands.TypeReader" /> to this <see cref="T:Discord.Commands.CommandService" /> for the supplied object
  705. type.
  706. If <typeparamref name="T" /> is a <see cref="T:System.ValueType" />, a nullable <see cref="T:Discord.Commands.TypeReader" /> will
  707. also be added.
  708. If a default <see cref="T:Discord.Commands.TypeReader" /> exists for <typeparamref name="T" />, a warning will be logged
  709. and the default <see cref="T:Discord.Commands.TypeReader" /> will be replaced.
  710. </summary>
  711. <typeparam name="T">The object type to be read by the <see cref="T:Discord.Commands.TypeReader"/>.</typeparam>
  712. <param name="reader">An instance of the <see cref="T:Discord.Commands.TypeReader" /> to be added.</param>
  713. </member>
  714. <member name="M:Discord.Commands.CommandService.AddTypeReader(System.Type,Discord.Commands.TypeReader)">
  715. <summary>
  716. Adds a custom <see cref="T:Discord.Commands.TypeReader" /> to this <see cref="T:Discord.Commands.CommandService" /> for the supplied object
  717. type.
  718. If <paramref name="type" /> is a <see cref="T:System.ValueType" />, a nullable <see cref="T:Discord.Commands.TypeReader" /> for the
  719. value type will also be added.
  720. If a default <see cref="T:Discord.Commands.TypeReader" /> exists for <paramref name="type" />, a warning will be logged and
  721. the default <see cref="T:Discord.Commands.TypeReader" /> will be replaced.
  722. </summary>
  723. <param name="type">A <see cref="T:System.Type" /> instance for the type to be read.</param>
  724. <param name="reader">An instance of the <see cref="T:Discord.Commands.TypeReader" /> to be added.</param>
  725. </member>
  726. <member name="M:Discord.Commands.CommandService.AddTypeReader``1(Discord.Commands.TypeReader,System.Boolean)">
  727. <summary>
  728. Adds a custom <see cref="T:Discord.Commands.TypeReader" /> to this <see cref="T:Discord.Commands.CommandService" /> for the supplied object
  729. type.
  730. If <typeparamref name="T" /> is a <see cref="T:System.ValueType" />, a nullable <see cref="T:Discord.Commands.TypeReader" /> will
  731. also be added.
  732. </summary>
  733. <typeparam name="T">The object type to be read by the <see cref="T:Discord.Commands.TypeReader"/>.</typeparam>
  734. <param name="reader">An instance of the <see cref="T:Discord.Commands.TypeReader" /> to be added.</param>
  735. <param name="replaceDefault">
  736. Defines whether the <see cref="T:Discord.Commands.TypeReader"/> should replace the default one for
  737. <see cref="T:System.Type" /> if it exists.
  738. </param>
  739. </member>
  740. <member name="M:Discord.Commands.CommandService.AddTypeReader(System.Type,Discord.Commands.TypeReader,System.Boolean)">
  741. <summary>
  742. Adds a custom <see cref="T:Discord.Commands.TypeReader" /> to this <see cref="T:Discord.Commands.CommandService" /> for the supplied object
  743. type.
  744. If <paramref name="type" /> is a <see cref="T:System.ValueType" />, a nullable <see cref="T:Discord.Commands.TypeReader" /> for the
  745. value type will also be added.
  746. </summary>
  747. <param name="type">A <see cref="T:System.Type" /> instance for the type to be read.</param>
  748. <param name="reader">An instance of the <see cref="T:Discord.Commands.TypeReader" /> to be added.</param>
  749. <param name="replaceDefault">
  750. Defines whether the <see cref="T:Discord.Commands.TypeReader"/> should replace the default one for <see cref="T:System.Type" /> if
  751. it exists.
  752. </param>
  753. </member>
  754. <member name="M:Discord.Commands.CommandService.Search(Discord.Commands.ICommandContext,System.Int32)">
  755. <summary>
  756. Searches for the command.
  757. </summary>
  758. <param name="context">The context of the command.</param>
  759. <param name="argPos">The position of which the command starts at.</param>
  760. <returns>The result containing the matching commands.</returns>
  761. </member>
  762. <member name="M:Discord.Commands.CommandService.Search(Discord.Commands.ICommandContext,System.String)">
  763. <summary>
  764. Searches for the command.
  765. </summary>
  766. <param name="context">The context of the command.</param>
  767. <param name="input">The command string.</param>
  768. <returns>The result containing the matching commands.</returns>
  769. </member>
  770. <member name="M:Discord.Commands.CommandService.ExecuteAsync(Discord.Commands.ICommandContext,System.Int32,System.IServiceProvider,Discord.Commands.MultiMatchHandling)">
  771. <summary>
  772. Executes the command.
  773. </summary>
  774. <param name="context">The context of the command.</param>
  775. <param name="argPos">The position of which the command starts at.</param>
  776. <param name="services">The service to be used in the command's dependency injection.</param>
  777. <param name="multiMatchHandling">The handling mode when multiple command matches are found.</param>
  778. <returns>
  779. A task that represents the asynchronous execution operation. The task result contains the result of the
  780. command execution.
  781. </returns>
  782. </member>
  783. <member name="M:Discord.Commands.CommandService.ExecuteAsync(Discord.Commands.ICommandContext,System.String,System.IServiceProvider,Discord.Commands.MultiMatchHandling)">
  784. <summary>
  785. Executes the command.
  786. </summary>
  787. <param name="context">The context of the command.</param>
  788. <param name="input">The command string.</param>
  789. <param name="services">The service to be used in the command's dependency injection.</param>
  790. <param name="multiMatchHandling">The handling mode when multiple command matches are found.</param>
  791. <returns>
  792. A task that represents the asynchronous execution operation. The task result contains the result of the
  793. command execution.
  794. </returns>
  795. </member>
  796. <member name="T:Discord.Commands.CommandServiceConfig">
  797. <summary>
  798. Represents a configuration class for <see cref="T:Discord.Commands.CommandService"/>.
  799. </summary>
  800. </member>
  801. <member name="P:Discord.Commands.CommandServiceConfig.DefaultRunMode">
  802. <summary>
  803. Gets or sets the default <see cref="T:Discord.Commands.RunMode" /> commands should have, if one is not specified on the
  804. Command attribute or builder.
  805. </summary>
  806. </member>
  807. <member name="P:Discord.Commands.CommandServiceConfig.SeparatorChar">
  808. <summary>
  809. Gets or sets the <see cref="T:System.Char"/> that separates an argument with another.
  810. </summary>
  811. </member>
  812. <member name="P:Discord.Commands.CommandServiceConfig.CaseSensitiveCommands">
  813. <summary>
  814. Gets or sets whether commands should be case-sensitive.
  815. </summary>
  816. </member>
  817. <member name="P:Discord.Commands.CommandServiceConfig.LogLevel">
  818. <summary>
  819. Gets or sets the minimum log level severity that will be sent to the <see cref="E:Discord.Commands.CommandService.Log"/> event.
  820. </summary>
  821. </member>
  822. <member name="P:Discord.Commands.CommandServiceConfig.ThrowOnError">
  823. <summary>
  824. Gets or sets whether <see cref="F:Discord.Commands.RunMode.Sync"/> commands should push exceptions up to the caller.
  825. </summary>
  826. </member>
  827. <member name="P:Discord.Commands.CommandServiceConfig.QuotationMarkAliasMap">
  828. <summary>
  829. Collection of aliases for matching pairs of string delimiters.
  830. The dictionary stores the opening delimiter as a key, and the matching closing delimiter as the value.
  831. If no value is supplied <see cref="P:Discord.Commands.QuotationAliasUtils.GetDefaultAliasMap"/> will be used, which contains
  832. many regional equivalents.
  833. Only values that are specified in this map will be used as string delimiters, so if " is removed then
  834. it won't be used.
  835. If this map is set to null or empty, the default delimiter of " will be used.
  836. </summary>
  837. <example>
  838. <code language="cs">
  839. QuotationMarkAliasMap = new Dictionary&lt;char, char&gt;()
  840. {
  841. {'\"', '\"' },
  842. {'“', '”' },
  843. {'「', '」' },
  844. }
  845. </code>
  846. </example>
  847. </member>
  848. <member name="P:Discord.Commands.CommandServiceConfig.IgnoreExtraArgs">
  849. <summary>
  850. Gets or sets a value that indicates whether extra parameters should be ignored.
  851. </summary>
  852. </member>
  853. <member name="T:Discord.Commands.CommandServiceExtensions">
  854. <summary>
  855. Provides extension methods for the <see cref="T:Discord.Commands.CommandService"/> class.
  856. </summary>
  857. </member>
  858. <member name="M:Discord.Commands.CommandServiceExtensions.GetExecutableCommandsAsync(System.Collections.Generic.ICollection{Discord.Commands.CommandInfo},Discord.Commands.ICommandContext,System.IServiceProvider)">
  859. <summary>
  860. Returns commands that can be executed under the current context.
  861. </summary>
  862. <param name="commands">The set of commands to be checked against.</param>
  863. <param name="context">The current command context.</param>
  864. <param name="provider">The service provider used for dependency injection upon precondition check.</param>
  865. <returns>
  866. A read-only collection of commands that can be executed under the current context.
  867. </returns>
  868. </member>
  869. <member name="M:Discord.Commands.CommandServiceExtensions.GetExecutableCommandsAsync(Discord.Commands.CommandService,Discord.Commands.ICommandContext,System.IServiceProvider)">
  870. <summary>
  871. Returns commands that can be executed under the current context.
  872. </summary>
  873. <param name="commandService">The desired command service class to check against.</param>
  874. <param name="context">The current command context.</param>
  875. <param name="provider">The service provider used for dependency injection upon precondition check.</param>
  876. <returns>
  877. A read-only collection of commands that can be executed under the current context.
  878. </returns>
  879. </member>
  880. <member name="M:Discord.Commands.CommandServiceExtensions.GetExecutableCommandsAsync(Discord.Commands.ModuleInfo,Discord.Commands.ICommandContext,System.IServiceProvider)">
  881. <summary>
  882. Returns commands that can be executed under the current context.
  883. </summary>
  884. <param name="module">The module to be checked against.</param>
  885. <param name="context">The current command context.</param>
  886. <param name="provider">The service provider used for dependency injection upon precondition check.</param>
  887. <returns>
  888. A read-only collection of commands that can be executed under the current context.
  889. </returns>
  890. </member>
  891. <member name="T:Discord.Commands.MessageExtensions">
  892. <summary>
  893. Provides extension methods for <see cref="T:Discord.IUserMessage" /> that relates to commands.
  894. </summary>
  895. </member>
  896. <member name="M:Discord.Commands.MessageExtensions.HasCharPrefix(Discord.IUserMessage,System.Char,System.Int32@)">
  897. <summary>
  898. Gets whether the message starts with the provided character.
  899. </summary>
  900. <param name="msg">The message to check against.</param>
  901. <param name="c">The char prefix.</param>
  902. <param name="argPos">References where the command starts.</param>
  903. <returns>
  904. <c>true</c> if the message begins with the char <paramref name="c"/>; otherwise <c>false</c>.
  905. </returns>
  906. </member>
  907. <member name="M:Discord.Commands.MessageExtensions.HasStringPrefix(Discord.IUserMessage,System.String,System.Int32@,System.StringComparison)">
  908. <summary>
  909. Gets whether the message starts with the provided string.
  910. </summary>
  911. </member>
  912. <member name="M:Discord.Commands.MessageExtensions.HasMentionPrefix(Discord.IUserMessage,Discord.IUser,System.Int32@)">
  913. <summary>
  914. Gets whether the message starts with the user's mention string.
  915. </summary>
  916. </member>
  917. <member name="T:Discord.Commands.CommandInfo">
  918. <summary>
  919. Provides the information of a command.
  920. </summary>
  921. <remarks>
  922. This object contains the information of a command. This can include the module of the command, various
  923. descriptions regarding the command, and its <see cref="P:Discord.Commands.CommandInfo.RunMode"/>.
  924. </remarks>
  925. </member>
  926. <member name="P:Discord.Commands.CommandInfo.Module">
  927. <summary>
  928. Gets the module that the command belongs in.
  929. </summary>
  930. </member>
  931. <member name="P:Discord.Commands.CommandInfo.Name">
  932. <summary>
  933. Gets the name of the command. If none is set, the first alias is used.
  934. </summary>
  935. </member>
  936. <member name="P:Discord.Commands.CommandInfo.Summary">
  937. <summary>
  938. Gets the summary of the command.
  939. </summary>
  940. <remarks>
  941. This field returns the summary of the command. <see cref="P:Discord.Commands.CommandInfo.Summary"/> and <see cref="P:Discord.Commands.CommandInfo.Remarks"/> can be
  942. useful in help commands and various implementation that fetches details of the command for the user.
  943. </remarks>
  944. </member>
  945. <member name="P:Discord.Commands.CommandInfo.Remarks">
  946. <summary>
  947. Gets the remarks of the command.
  948. </summary>
  949. <remarks>
  950. This field returns the summary of the command. <see cref="P:Discord.Commands.CommandInfo.Summary"/> and <see cref="P:Discord.Commands.CommandInfo.Remarks"/> can be
  951. useful in help commands and various implementation that fetches details of the command for the user.
  952. </remarks>
  953. </member>
  954. <member name="P:Discord.Commands.CommandInfo.Priority">
  955. <summary>
  956. Gets the priority of the command. This is used when there are multiple overloads of the command.
  957. </summary>
  958. </member>
  959. <member name="P:Discord.Commands.CommandInfo.HasVarArgs">
  960. <summary>
  961. Indicates whether the command accepts a <see langword="params"/> <see cref="T:System.Type"/>[] for its
  962. parameter.
  963. </summary>
  964. </member>
  965. <member name="P:Discord.Commands.CommandInfo.IgnoreExtraArgs">
  966. <summary>
  967. Indicates whether extra arguments should be ignored for this command.
  968. </summary>
  969. </member>
  970. <member name="P:Discord.Commands.CommandInfo.RunMode">
  971. <summary>
  972. Gets the <see cref="P:Discord.Commands.CommandInfo.RunMode" /> that is being used for the command.
  973. </summary>
  974. </member>
  975. <member name="P:Discord.Commands.CommandInfo.Aliases">
  976. <summary>
  977. Gets a list of aliases defined by the <see cref="T:Discord.Commands.AliasAttribute" /> of the command.
  978. </summary>
  979. </member>
  980. <member name="P:Discord.Commands.CommandInfo.Parameters">
  981. <summary>
  982. Gets a list of information about the parameters of the command.
  983. </summary>
  984. </member>
  985. <member name="P:Discord.Commands.CommandInfo.Preconditions">
  986. <summary>
  987. Gets a list of preconditions defined by the <see cref="T:Discord.Commands.PreconditionAttribute" /> of the command.
  988. </summary>
  989. </member>
  990. <member name="P:Discord.Commands.CommandInfo.Attributes">
  991. <summary>
  992. Gets a list of attributes of the command.
  993. </summary>
  994. </member>
  995. <member name="T:Discord.Commands.ModuleInfo">
  996. <summary>
  997. Provides the information of a module.
  998. </summary>
  999. </member>
  1000. <member name="P:Discord.Commands.ModuleInfo.Service">
  1001. <summary>
  1002. Gets the command service associated with this module.
  1003. </summary>
  1004. </member>
  1005. <member name="P:Discord.Commands.ModuleInfo.Name">
  1006. <summary>
  1007. Gets the name of this module.
  1008. </summary>
  1009. </member>
  1010. <member name="P:Discord.Commands.ModuleInfo.Summary">
  1011. <summary>
  1012. Gets the summary of this module.
  1013. </summary>
  1014. </member>
  1015. <member name="P:Discord.Commands.ModuleInfo.Remarks">
  1016. <summary>
  1017. Gets the remarks of this module.
  1018. </summary>
  1019. </member>
  1020. <member name="P:Discord.Commands.ModuleInfo.Group">
  1021. <summary>
  1022. Gets the group name (main prefix) of this module.
  1023. </summary>
  1024. </member>
  1025. <member name="P:Discord.Commands.ModuleInfo.Aliases">
  1026. <summary>
  1027. Gets a read-only list of aliases associated with this module.
  1028. </summary>
  1029. </member>
  1030. <member name="P:Discord.Commands.ModuleInfo.Commands">
  1031. <summary>
  1032. Gets a read-only list of commands associated with this module.
  1033. </summary>
  1034. </member>
  1035. <member name="P:Discord.Commands.ModuleInfo.Preconditions">
  1036. <summary>
  1037. Gets a read-only list of preconditions that apply to this module.
  1038. </summary>
  1039. </member>
  1040. <member name="P:Discord.Commands.ModuleInfo.Attributes">
  1041. <summary>
  1042. Gets a read-only list of attributes that apply to this module.
  1043. </summary>
  1044. </member>
  1045. <member name="P:Discord.Commands.ModuleInfo.Submodules">
  1046. <summary>
  1047. Gets a read-only list of submodules associated with this module.
  1048. </summary>
  1049. </member>
  1050. <member name="P:Discord.Commands.ModuleInfo.Parent">
  1051. <summary>
  1052. Gets the parent module of this submodule if applicable.
  1053. </summary>
  1054. </member>
  1055. <member name="P:Discord.Commands.ModuleInfo.IsSubmodule">
  1056. <summary>
  1057. Gets a value that indicates whether this module is a submodule or not.
  1058. </summary>
  1059. </member>
  1060. <member name="T:Discord.Commands.ParameterInfo">
  1061. <summary>
  1062. Provides the information of a parameter.
  1063. </summary>
  1064. </member>
  1065. <member name="P:Discord.Commands.ParameterInfo.Command">
  1066. <summary>
  1067. Gets the command that associates with this parameter.
  1068. </summary>
  1069. </member>
  1070. <member name="P:Discord.Commands.ParameterInfo.Name">
  1071. <summary>
  1072. Gets the name of this parameter.
  1073. </summary>
  1074. </member>
  1075. <member name="P:Discord.Commands.ParameterInfo.Summary">
  1076. <summary>
  1077. Gets the summary of this parameter.
  1078. </summary>
  1079. </member>
  1080. <member name="P:Discord.Commands.ParameterInfo.IsOptional">
  1081. <summary>
  1082. Gets a value that indicates whether this parameter is optional or not.
  1083. </summary>
  1084. </member>
  1085. <member name="P:Discord.Commands.ParameterInfo.IsRemainder">
  1086. <summary>
  1087. Gets a value that indicates whether this parameter is a remainder parameter or not.
  1088. </summary>
  1089. </member>
  1090. <member name="P:Discord.Commands.ParameterInfo.Type">
  1091. <summary>
  1092. Gets the type of the parameter.
  1093. </summary>
  1094. </member>
  1095. <member name="P:Discord.Commands.ParameterInfo.DefaultValue">
  1096. <summary>
  1097. Gets the default value for this optional parameter if applicable.
  1098. </summary>
  1099. </member>
  1100. <member name="P:Discord.Commands.ParameterInfo.Preconditions">
  1101. <summary>
  1102. Gets a read-only list of precondition that apply to this parameter.
  1103. </summary>
  1104. </member>
  1105. <member name="P:Discord.Commands.ParameterInfo.Attributes">
  1106. <summary>
  1107. Gets a read-only list of attributes that apply to this parameter.
  1108. </summary>
  1109. </member>
  1110. <member name="M:Discord.Commands.CommandMapNode.AddCommand(Discord.Commands.CommandService,System.String,System.Int32,Discord.Commands.CommandInfo)">
  1111. <exception cref="T:System.InvalidOperationException">Cannot add commands to the root node.</exception>
  1112. </member>
  1113. <member name="T:Discord.Commands.ModuleBase">
  1114. <summary>
  1115. Provides a base class for a command module to inherit from.
  1116. </summary>
  1117. </member>
  1118. <member name="T:Discord.Commands.ModuleBase`1">
  1119. <summary>
  1120. Provides a base class for a command module to inherit from.
  1121. </summary>
  1122. <typeparam name="T">A class that implements <see cref="T:Discord.Commands.ICommandContext"/>.</typeparam>
  1123. </member>
  1124. <member name="P:Discord.Commands.ModuleBase`1.Context">
  1125. <summary>
  1126. The underlying context of the command.
  1127. </summary>
  1128. <seealso cref="T:Discord.Commands.ICommandContext" />
  1129. <seealso cref="T:Discord.Commands.CommandContext" />
  1130. </member>
  1131. <member name="M:Discord.Commands.ModuleBase`1.ReplyAsync(System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[],Discord.Embed[])">
  1132. <summary>
  1133. Sends a message to the source channel.
  1134. </summary>
  1135. <param name="message">
  1136. Contents of the message; optional only if <paramref name="embed" /> is specified.
  1137. </param>
  1138. <param name="isTTS">Specifies if Discord should read this <paramref name="message"/> aloud using text-to-speech.</param>
  1139. <param name="embed">An embed to be displayed alongside the <paramref name="message"/>.</param>
  1140. <param name="allowedMentions">
  1141. Specifies if notifications are sent for mentioned users and roles in the <paramref name="message"/>.
  1142. If <c>null</c>, all mentioned roles and users will be notified.
  1143. </param>
  1144. <param name="options">The request options for this async request.</param>
  1145. <param name="messageReference">The message references to be included. Used to reply to specific messages.</param>
  1146. <param name="component">The message components to be included with this message. Used for interactions.</param>
  1147. <param name="stickers">A collection of stickers to send with the file.</param>
  1148. <param name="embeds">A array of <see cref="T:Discord.Embed"/>s to send with this response. Max 10.</param>
  1149. </member>
  1150. <member name="M:Discord.Commands.ModuleBase`1.BeforeExecute(Discord.Commands.CommandInfo)">
  1151. <summary>
  1152. The method to execute before executing the command.
  1153. </summary>
  1154. <param name="command">The <see cref="T:Discord.Commands.CommandInfo"/> of the command to be executed.</param>
  1155. </member>
  1156. <member name="M:Discord.Commands.ModuleBase`1.AfterExecute(Discord.Commands.CommandInfo)">
  1157. <summary>
  1158. The method to execute after executing the command.
  1159. </summary>
  1160. <param name="command">The <see cref="T:Discord.Commands.CommandInfo"/> of the command to be executed.</param>
  1161. </member>
  1162. <member name="M:Discord.Commands.ModuleBase`1.OnModuleBuilding(Discord.Commands.CommandService,Discord.Commands.Builders.ModuleBuilder)">
  1163. <summary>
  1164. The method to execute when building the module.
  1165. </summary>
  1166. <param name="commandService">The <see cref="T:Discord.Commands.CommandService"/> used to create the module.</param>
  1167. <param name="builder">The builder used to build the module.</param>
  1168. </member>
  1169. <member name="T:Discord.Commands.MultiMatchHandling">
  1170. <summary>
  1171. Specifies the behavior when multiple matches are found during the command parsing stage.
  1172. </summary>
  1173. </member>
  1174. <member name="F:Discord.Commands.MultiMatchHandling.Exception">
  1175. <summary> Indicates that when multiple results are found, an exception should be thrown. </summary>
  1176. </member>
  1177. <member name="F:Discord.Commands.MultiMatchHandling.Best">
  1178. <summary> Indicates that when multiple results are found, the best result should be chosen. </summary>
  1179. </member>
  1180. <member name="T:Discord.Commands.ChannelTypeReader`1">
  1181. <summary>
  1182. A <see cref="T:Discord.Commands.TypeReader"/> for parsing objects implementing <see cref="T:Discord.IChannel"/>.
  1183. </summary>
  1184. <remarks>
  1185. This <see cref="T:Discord.Commands.TypeReader"/> is shipped with Discord.Net and is used by default to parse any
  1186. <see cref="T:Discord.IChannel"/> implemented object within a command. The TypeReader will attempt to first parse the
  1187. input by mention, then the snowflake identifier, then by name; the highest candidate will be chosen as the
  1188. final output; otherwise, an erroneous <see cref="T:Discord.Commands.TypeReaderResult"/> is returned.
  1189. </remarks>
  1190. <typeparam name="T">The type to be checked; must implement <see cref="T:Discord.IChannel"/>.</typeparam>
  1191. </member>
  1192. <member name="M:Discord.Commands.ChannelTypeReader`1.ReadAsync(Discord.Commands.ICommandContext,System.String,System.IServiceProvider)">
  1193. <inheritdoc />
  1194. </member>
  1195. <member name="M:Discord.Commands.EnumTypeReader`1.ReadAsync(Discord.Commands.ICommandContext,System.String,System.IServiceProvider)">
  1196. <inheritdoc />
  1197. </member>
  1198. <member name="T:Discord.Commands.MessageTypeReader`1">
  1199. <summary>
  1200. A <see cref="T:Discord.Commands.TypeReader"/> for parsing objects implementing <see cref="T:Discord.IMessage"/>.
  1201. </summary>
  1202. <typeparam name="T">The type to be checked; must implement <see cref="T:Discord.IMessage"/>.</typeparam>
  1203. </member>
  1204. <member name="M:Discord.Commands.MessageTypeReader`1.ReadAsync(Discord.Commands.ICommandContext,System.String,System.IServiceProvider)">
  1205. <inheritdoc />
  1206. </member>
  1207. <member name="M:Discord.Commands.NullableTypeReader`1.ReadAsync(Discord.Commands.ICommandContext,System.String,System.IServiceProvider)">
  1208. <inheritdoc />
  1209. </member>
  1210. <member name="M:Discord.Commands.PrimitiveTypeReader`1.#ctor">
  1211. <exception cref="T:System.ArgumentOutOfRangeException"><typeparamref name="T"/> must be within the range [0, 1].</exception>
  1212. </member>
  1213. <member name="M:Discord.Commands.PrimitiveTypeReader`1.#ctor(Discord.Commands.TryParseDelegate{`0},System.Single)">
  1214. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="score"/> must be within the range [0, 1].</exception>
  1215. </member>
  1216. <member name="T:Discord.Commands.RoleTypeReader`1">
  1217. <summary>
  1218. A <see cref="T:Discord.Commands.TypeReader"/> for parsing objects implementing <see cref="T:Discord.IRole"/>.
  1219. </summary>
  1220. <typeparam name="T">The type to be checked; must implement <see cref="T:Discord.IRole"/>.</typeparam>
  1221. </member>
  1222. <member name="M:Discord.Commands.RoleTypeReader`1.ReadAsync(Discord.Commands.ICommandContext,System.String,System.IServiceProvider)">
  1223. <inheritdoc />
  1224. </member>
  1225. <member name="M:Discord.Commands.TimeSpanTypeReader.ReadAsync(Discord.Commands.ICommandContext,System.String,System.IServiceProvider)">
  1226. <inheritdoc />
  1227. </member>
  1228. <member name="T:Discord.Commands.TypeReader">
  1229. <summary>
  1230. Defines a reader class that parses user input into a specified type.
  1231. </summary>
  1232. </member>
  1233. <member name="M:Discord.Commands.TypeReader.ReadAsync(Discord.Commands.ICommandContext,System.String,System.IServiceProvider)">
  1234. <summary>
  1235. Attempts to parse the <paramref name="input"/> into the desired type.
  1236. </summary>
  1237. <param name="context">The context of the command.</param>
  1238. <param name="input">The raw input of the command.</param>
  1239. <param name="services">The service collection used for dependency injection.</param>
  1240. <returns>
  1241. A task that represents the asynchronous parsing operation. The task result contains the parsing result.
  1242. </returns>
  1243. </member>
  1244. <member name="T:Discord.Commands.UserTypeReader`1">
  1245. <summary>
  1246. A <see cref="T:Discord.Commands.TypeReader"/> for parsing objects implementing <see cref="T:Discord.IUser"/>.
  1247. </summary>
  1248. <typeparam name="T">The type to be checked; must implement <see cref="T:Discord.IUser"/>.</typeparam>
  1249. </member>
  1250. <member name="M:Discord.Commands.UserTypeReader`1.ReadAsync(Discord.Commands.ICommandContext,System.String,System.IServiceProvider)">
  1251. <inheritdoc />
  1252. </member>
  1253. <member name="T:Discord.Commands.ExecuteResult">
  1254. <summary>
  1255. Contains information of the command's overall execution result.
  1256. </summary>
  1257. </member>
  1258. <member name="P:Discord.Commands.ExecuteResult.Exception">
  1259. <summary>
  1260. Gets the exception that may have occurred during the command execution.
  1261. </summary>
  1262. </member>
  1263. <member name="P:Discord.Commands.ExecuteResult.Error">
  1264. <inheritdoc />
  1265. </member>
  1266. <member name="P:Discord.Commands.ExecuteResult.ErrorReason">
  1267. <inheritdoc />
  1268. </member>
  1269. <member name="P:Discord.Commands.ExecuteResult.IsSuccess">
  1270. <inheritdoc />
  1271. </member>
  1272. <member name="M:Discord.Commands.ExecuteResult.FromSuccess">
  1273. <summary>
  1274. Initializes a new <see cref="T:Discord.Commands.ExecuteResult" /> with no error, indicating a successful execution.
  1275. </summary>
  1276. <returns>
  1277. A <see cref="T:Discord.Commands.ExecuteResult" /> that does not contain any errors.
  1278. </returns>
  1279. </member>
  1280. <member name="M:Discord.Commands.ExecuteResult.FromError(Discord.Commands.CommandError,System.String)">
  1281. <summary>
  1282. Initializes a new <see cref="T:Discord.Commands.ExecuteResult" /> with a specified <see cref="T:Discord.Commands.CommandError" /> and its
  1283. reason, indicating an unsuccessful execution.
  1284. </summary>
  1285. <param name="error">The type of error.</param>
  1286. <param name="reason">The reason behind the error.</param>
  1287. <returns>
  1288. A <see cref="T:Discord.Commands.ExecuteResult" /> that contains a <see cref="T:Discord.Commands.CommandError" /> and reason.
  1289. </returns>
  1290. </member>
  1291. <member name="M:Discord.Commands.ExecuteResult.FromError(System.Exception)">
  1292. <summary>
  1293. Initializes a new <see cref="T:Discord.Commands.ExecuteResult" /> with a specified exception, indicating an unsuccessful
  1294. execution.
  1295. </summary>
  1296. <param name="ex">The exception that caused the command execution to fail.</param>
  1297. <returns>
  1298. A <see cref="T:Discord.Commands.ExecuteResult" /> that contains the exception that caused the unsuccessful execution, along
  1299. with a <see cref="T:Discord.Commands.CommandError" /> of type <c>Exception</c> as well as the exception message as the
  1300. reason.
  1301. </returns>
  1302. </member>
  1303. <member name="M:Discord.Commands.ExecuteResult.FromError(Discord.Commands.IResult)">
  1304. <summary>
  1305. Initializes a new <see cref="T:Discord.Commands.ExecuteResult" /> with a specified result; this may or may not be an
  1306. successful execution depending on the <see cref="P:Discord.Commands.IResult.Error" /> and
  1307. <see cref="P:Discord.Commands.IResult.ErrorReason" /> specified.
  1308. </summary>
  1309. <param name="result">The result to inherit from.</param>
  1310. <returns>
  1311. A <see cref="T:Discord.Commands.ExecuteResult"/> that inherits the <see cref="T:Discord.Commands.IResult"/> error type and reason.
  1312. </returns>
  1313. </member>
  1314. <member name="M:Discord.Commands.ExecuteResult.ToString">
  1315. <summary>
  1316. Gets a string that indicates the execution result.
  1317. </summary>
  1318. <returns>
  1319. <c>Success</c> if <see cref="P:Discord.Commands.ExecuteResult.IsSuccess"/> is <c>true</c>; otherwise "<see cref="P:Discord.Commands.ExecuteResult.Error"/>:
  1320. <see cref="P:Discord.Commands.ExecuteResult.ErrorReason"/>".
  1321. </returns>
  1322. </member>
  1323. <member name="T:Discord.Commands.IResult">
  1324. <summary>
  1325. Contains information of the result related to a command.
  1326. </summary>
  1327. </member>
  1328. <member name="P:Discord.Commands.IResult.Error">
  1329. <summary>
  1330. Describes the error type that may have occurred during the operation.
  1331. </summary>
  1332. <returns>
  1333. A <see cref="T:Discord.Commands.CommandError" /> indicating the type of error that may have occurred during the operation;
  1334. <c>null</c> if the operation was successful.
  1335. </returns>
  1336. </member>
  1337. <member name="P:Discord.Commands.IResult.ErrorReason">
  1338. <summary>
  1339. Describes the reason for the error.
  1340. </summary>
  1341. <returns>
  1342. A string containing the error reason.
  1343. </returns>
  1344. </member>
  1345. <member name="P:Discord.Commands.IResult.IsSuccess">
  1346. <summary>
  1347. Indicates whether the operation was successful or not.
  1348. </summary>
  1349. <returns>
  1350. <c>true</c> if the result is positive; otherwise <c>false</c>.
  1351. </returns>
  1352. </member>
  1353. <member name="T:Discord.Commands.ParseResult">
  1354. <summary>
  1355. Contains information for the parsing result from the command service's parser.
  1356. </summary>
  1357. </member>
  1358. <member name="P:Discord.Commands.ParseResult.Error">
  1359. <inheritdoc/>
  1360. </member>
  1361. <member name="P:Discord.Commands.ParseResult.ErrorReason">
  1362. <inheritdoc/>
  1363. </member>
  1364. <member name="P:Discord.Commands.ParseResult.ErrorParameter">
  1365. <summary>
  1366. Provides information about the parameter that caused the parsing error.
  1367. </summary>
  1368. <returns>
  1369. A <see cref="T:Discord.Commands.ParameterInfo" /> indicating the parameter info of the error that may have occurred during parsing;
  1370. <c>null</c> if the parsing was successful or the parsing error is not specific to a single parameter.
  1371. </returns>
  1372. </member>
  1373. <member name="P:Discord.Commands.ParseResult.IsSuccess">
  1374. <inheritdoc/>
  1375. </member>
  1376. <member name="T:Discord.Commands.PreconditionResult">
  1377. <summary>
  1378. Represents a result type for command preconditions.
  1379. </summary>
  1380. </member>
  1381. <member name="P:Discord.Commands.PreconditionResult.Error">
  1382. <inheritdoc/>
  1383. </member>
  1384. <member name="P:Discord.Commands.PreconditionResult.ErrorReason">
  1385. <inheritdoc/>
  1386. </member>
  1387. <member name="P:Discord.Commands.PreconditionResult.IsSuccess">
  1388. <inheritdoc/>
  1389. </member>
  1390. <member name="M:Discord.Commands.PreconditionResult.#ctor(System.Nullable{Discord.Commands.CommandError},System.String)">
  1391. <summary>
  1392. Initializes a new <see cref="T:Discord.Commands.PreconditionResult" /> class with the command <paramref name="error"/> type
  1393. and reason.
  1394. </summary>
  1395. <param name="error">The type of failure.</param>
  1396. <param name="errorReason">The reason of failure.</param>
  1397. </member>
  1398. <member name="M:Discord.Commands.PreconditionResult.FromSuccess">
  1399. <summary>
  1400. Returns a <see cref="T:Discord.Commands.PreconditionResult" /> with no errors.
  1401. </summary>
  1402. </member>
  1403. <member name="M:Discord.Commands.PreconditionResult.FromError(System.String)">
  1404. <summary>
  1405. Returns a <see cref="T:Discord.Commands.PreconditionResult" /> with <see cref="F:Discord.Commands.CommandError.UnmetPrecondition" /> and the
  1406. specified reason.
  1407. </summary>
  1408. <param name="reason">The reason of failure.</param>
  1409. </member>
  1410. <member name="M:Discord.Commands.PreconditionResult.FromError(Discord.Commands.IResult)">
  1411. <summary>
  1412. Returns a <see cref="T:Discord.Commands.PreconditionResult" /> with the specified <paramref name="result"/> type.
  1413. </summary>
  1414. <param name="result">The result of failure.</param>
  1415. </member>
  1416. <member name="M:Discord.Commands.PreconditionResult.ToString">
  1417. <summary>
  1418. Returns a string indicating whether the <see cref="T:Discord.Commands.PreconditionResult"/> is successful.
  1419. </summary>
  1420. </member>
  1421. <member name="M:Discord.Commands.RuntimeResult.#ctor(System.Nullable{Discord.Commands.CommandError},System.String)">
  1422. <summary>
  1423. Initializes a new <see cref="T:Discord.Commands.RuntimeResult" /> class with the type of error and reason.
  1424. </summary>
  1425. <param name="error">The type of failure, or <c>null</c> if none.</param>
  1426. <param name="reason">The reason of failure.</param>
  1427. </member>
  1428. <member name="P:Discord.Commands.RuntimeResult.Error">
  1429. <inheritdoc/>
  1430. </member>
  1431. <member name="P:Discord.Commands.RuntimeResult.Reason">
  1432. <summary> Describes the execution reason or result. </summary>
  1433. </member>
  1434. <member name="P:Discord.Commands.RuntimeResult.IsSuccess">
  1435. <inheritdoc/>
  1436. </member>
  1437. <member name="P:Discord.Commands.RuntimeResult.Discord#Commands#IResult#ErrorReason">
  1438. <inheritdoc/>
  1439. </member>
  1440. <member name="P:Discord.Commands.SearchResult.Error">
  1441. <inheritdoc/>
  1442. </member>
  1443. <member name="P:Discord.Commands.SearchResult.ErrorReason">
  1444. <inheritdoc/>
  1445. </member>
  1446. <member name="P:Discord.Commands.SearchResult.IsSuccess">
  1447. <inheritdoc/>
  1448. </member>
  1449. <member name="P:Discord.Commands.TypeReaderResult.Error">
  1450. <inheritdoc/>
  1451. </member>
  1452. <member name="P:Discord.Commands.TypeReaderResult.ErrorReason">
  1453. <inheritdoc/>
  1454. </member>
  1455. <member name="P:Discord.Commands.TypeReaderResult.IsSuccess">
  1456. <inheritdoc/>
  1457. </member>
  1458. <member name="P:Discord.Commands.TypeReaderResult.BestMatch">
  1459. <exception cref="T:System.InvalidOperationException">TypeReaderResult was not successful.</exception>
  1460. </member>
  1461. <member name="T:Discord.Commands.RunMode">
  1462. <summary>
  1463. Specifies the behavior of the command execution workflow.
  1464. </summary>
  1465. <seealso cref="T:Discord.Commands.CommandServiceConfig"/>
  1466. <seealso cref="T:Discord.Commands.CommandAttribute"/>
  1467. </member>
  1468. <member name="F:Discord.Commands.RunMode.Default">
  1469. <summary>
  1470. The default behaviour set in <see cref="T:Discord.Commands.CommandServiceConfig"/>.
  1471. </summary>
  1472. </member>
  1473. <member name="F:Discord.Commands.RunMode.Sync">
  1474. <summary>
  1475. Executes the command on the same thread as gateway one.
  1476. </summary>
  1477. </member>
  1478. <member name="F:Discord.Commands.RunMode.Async">
  1479. <summary>
  1480. Executes the command on a different thread from the gateway one.
  1481. </summary>
  1482. </member>
  1483. <member name="T:Discord.Commands.QuotationAliasUtils">
  1484. <summary>
  1485. Utility class which contains the default matching pairs of quotation marks for CommandServiceConfig
  1486. </summary>
  1487. </member>
  1488. <member name="P:Discord.Commands.QuotationAliasUtils.GetDefaultAliasMap">
  1489. <summary>
  1490. A default map of open-close pairs of quotation marks.
  1491. Contains many regional and Unicode equivalents.
  1492. Used in the <see cref="T:Discord.Commands.CommandServiceConfig"/>.
  1493. </summary>
  1494. <seealso cref="P:Discord.Commands.CommandServiceConfig.QuotationMarkAliasMap"/>
  1495. </member>
  1496. </members>
  1497. </doc>