|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>Discord.Net.Rest</name>
- </assembly>
- <members>
- <member name="T:Discord.API.InviteVanity">
- <summary>
- Represents a vanity invite.
- </summary>
- </member>
- <member name="P:Discord.API.InviteVanity.Code">
- <summary>
- The unique code for the invite link.
- </summary>
- </member>
- <member name="P:Discord.API.InviteVanity.Uses">
- <summary>
- The total amount of vanity invite uses.
- </summary>
- </member>
- <member name="P:Discord.API.MessageApplication.Id">
- <summary>
- Gets the snowflake ID of the application.
- </summary>
- </member>
- <member name="P:Discord.API.MessageApplication.CoverImage">
- <summary>
- Gets the ID of the embed's image asset.
- </summary>
- </member>
- <member name="P:Discord.API.MessageApplication.Description">
- <summary>
- Gets the application's description.
- </summary>
- </member>
- <member name="P:Discord.API.MessageApplication.Icon">
- <summary>
- Gets the ID of the application's icon.
- </summary>
- </member>
- <member name="P:Discord.API.MessageApplication.Name">
- <summary>
- Gets the name of the application.
- </summary>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.#ctor(Discord.Net.Rest.RestClientProvider,System.String,Discord.RetryMode,Newtonsoft.Json.JsonSerializer,System.Boolean)">
- <exception cref="T:System.ArgumentException">Unknown OAuth token type.</exception>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.SetBaseUrl(System.String)">
- <exception cref="T:System.ArgumentException">Unknown OAuth token type.</exception>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.GetPrefixedToken(Discord.TokenType,System.String)">
- <exception cref="T:System.ArgumentException">Unknown OAuth token type.</exception>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.ModifyGuildChannelAsync(System.UInt64,Discord.API.Rest.ModifyGuildChannelParams,Discord.RequestOptions)">
- <exception cref="T:System.ArgumentException">
- <paramref name="channelId"/> must not be equal to zero.
- -and-
- <paramref name="args.Position.Position"/> must be greater than zero.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="args"/> must not be <see langword="null"/>.
- -and-
- <paramref name="args.Name.Name"/> must not be <see langword="null"/> or empty.
- </exception>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.CreateMessageAsync(System.UInt64,Discord.API.Rest.CreateMessageParams,Discord.RequestOptions)">
- <exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.CreateWebhookMessageAsync(System.UInt64,Discord.API.Rest.CreateWebhookMessageParams,Discord.RequestOptions)">
- <exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
- <exception cref="T:System.InvalidOperationException">This operation may only be called with a <see cref="F:Discord.TokenType.Webhook"/> token.</exception>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.ModifyWebhookMessageAsync(System.UInt64,System.UInt64,Discord.API.Rest.ModifyWebhookMessageParams,Discord.RequestOptions)">
- <exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
- <exception cref="T:System.InvalidOperationException">This operation may only be called with a <see cref="F:Discord.TokenType.Webhook"/> token.</exception>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.DeleteWebhookMessageAsync(System.UInt64,System.UInt64,Discord.RequestOptions)">
- <exception cref="T:System.InvalidOperationException">This operation may only be called with a <see cref="F:Discord.TokenType.Webhook"/> token.</exception>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.UploadFileAsync(System.UInt64,Discord.API.Rest.UploadFileParams,Discord.RequestOptions)">
- <exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.UploadWebhookFileAsync(System.UInt64,Discord.API.Rest.UploadWebhookFileParams,Discord.RequestOptions)">
- <exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
- <exception cref="T:System.InvalidOperationException">This operation may only be called with a <see cref="F:Discord.TokenType.Webhook"/> token.</exception>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.ModifyMessageAsync(System.UInt64,System.UInt64,Discord.API.Rest.ModifyMessageParams,Discord.RequestOptions)">
- <exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.CreateGuildBanAsync(System.UInt64,System.UInt64,Discord.API.Rest.CreateGuildBanParams,Discord.RequestOptions)">
- <exception cref="T:System.ArgumentException">
- <paramref name="guildId"/> and <paramref name="userId"/> must not be equal to zero.
- -and-
- <paramref name="args.DeleteMessageDays.DeleteMessageDays"/> must be between 0 to 7.
- </exception>
- <exception cref="T:System.ArgumentNullException"><paramref name="args"/> must not be <see langword="null"/>.</exception>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.RemoveGuildBanAsync(System.UInt64,System.UInt64,Discord.RequestOptions)">
- <exception cref="T:System.ArgumentException"><paramref name="guildId"/> and <paramref name="userId"/> must not be equal to zero.</exception>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.GetGuildWidgetAsync(System.UInt64,Discord.RequestOptions)">
- <exception cref="T:System.ArgumentException"><paramref name="guildId"/> must not be equal to zero.</exception>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.ModifyGuildWidgetAsync(System.UInt64,Discord.API.Rest.ModifyGuildWidgetParams,Discord.RequestOptions)">
- <exception cref="T:System.ArgumentException"><paramref name="guildId"/> must not be equal to zero.</exception>
- <exception cref="T:System.ArgumentNullException"><paramref name="args"/> must not be <see langword="null"/>.</exception>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.GetGuildIntegrationsAsync(System.UInt64,Discord.RequestOptions)">
- <exception cref="T:System.ArgumentException"><paramref name="guildId"/> must not be equal to zero.</exception>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.CreateGuildIntegrationAsync(System.UInt64,Discord.API.Rest.CreateGuildIntegrationParams,Discord.RequestOptions)">
- <exception cref="T:System.ArgumentException"><paramref name="guildId"/> and <paramref name="args.Id.Id"/> must not be equal to zero.</exception>
- <exception cref="T:System.ArgumentNullException"><paramref name="args"/> must not be <see langword="null"/>.</exception>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.GetInviteAsync(System.String,Discord.RequestOptions)">
- <exception cref="T:System.ArgumentException"><paramref name="inviteId"/> cannot be blank.</exception>
- <exception cref="T:System.ArgumentNullException"><paramref name="inviteId"/> must not be <see langword="null"/>.</exception>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.GetVanityInviteAsync(System.UInt64,Discord.RequestOptions)">
- <exception cref="T:System.ArgumentException"><paramref name="guildId"/> may not be equal to zero.</exception>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.GetGuildInvitesAsync(System.UInt64,Discord.RequestOptions)">
- <exception cref="T:System.ArgumentException"><paramref name="guildId"/> may not be equal to zero.</exception>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.GetChannelInvitesAsync(System.UInt64,Discord.RequestOptions)">
- <exception cref="T:System.ArgumentException"><paramref name="channelId"/> may not be equal to zero.</exception>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.CreateChannelInviteAsync(System.UInt64,Discord.API.Rest.CreateChannelInviteParams,Discord.RequestOptions)">
- <exception cref="T:System.ArgumentException">
- <paramref name="channelId"/> may not be equal to zero.
- -and-
- <paramref name="args.MaxAge.MaxAge"/> and <paramref name="args.MaxUses.MaxUses"/> must be greater than zero.
- -and-
- <paramref name="args.MaxAge.MaxAge"/> must be lesser than 86400.
- </exception>
- <exception cref="T:System.ArgumentNullException"><paramref name="args"/> must not be <see langword="null"/>.</exception>
- </member>
- <member name="M:Discord.API.DiscordRestApiClient.CheckState">
- <exception cref="T:System.InvalidOperationException">Client is not logged in.</exception>
- </member>
- <member name="M:Discord.Net.Rest.DefaultRestClient.SendAsync(System.String,System.String,System.Collections.Generic.IReadOnlyDictionary{System.String,System.Object},System.Threading.CancellationToken,System.Boolean,System.String)">
- <exception cref="T:System.InvalidOperationException">Unsupported param type.</exception>
- </member>
- <member name="M:Discord.Net.Rest.DefaultRestClientProvider.Create(System.Boolean)">
- <exception cref="T:System.PlatformNotSupportedException">The default RestClientProvider is not supported on this platform.</exception>
- </member>
- <member name="M:Discord.Net.Converters.ImageConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
- <exception cref="T:System.InvalidOperationException">Cannot read from image.</exception>
- </member>
- <member name="T:Discord.Net.RateLimitInfo">
- <summary>
- Represents a REST-Based ratelimit info.
- </summary>
- </member>
- <member name="P:Discord.Net.RateLimitInfo.IsGlobal">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Net.RateLimitInfo.Limit">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Net.RateLimitInfo.Remaining">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Net.RateLimitInfo.RetryAfter">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Net.RateLimitInfo.Reset">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Net.RateLimitInfo.ResetAfter">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Net.RateLimitInfo.Bucket">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Net.RateLimitInfo.Lag">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Net.RateLimitInfo.Endpoint">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.BaseDiscordClient.LoginState">
- <summary>
- Gets the login state of the client.
- </summary>
- </member>
- <member name="P:Discord.Rest.BaseDiscordClient.CurrentUser">
- <summary>
- Gets the logged-in user.
- </summary>
- </member>
- <member name="P:Discord.Rest.BaseDiscordClient.TokenType">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.#ctor(Discord.Rest.DiscordRestConfig,Discord.API.DiscordRestApiClient)">
- <summary> Creates a new REST-only Discord client. </summary>
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.Dispose">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.GetRecommendedShardCountAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.GetBotGatewayAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#ConnectionState">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#CurrentUser">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetApplicationInfoAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetPrivateChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetDMChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetGroupChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetConnectionsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetInviteAsync(System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetGuildAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetGuildsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#CreateGuildAsync(System.String,Discord.IVoiceRegion,System.IO.Stream,Discord.RequestOptions)">
- <inheritdoc />
- <exception cref="T:System.NotSupportedException">Creating a guild is not supported with the base client.</exception>
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetUserAsync(System.String,System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetVoiceRegionsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetVoiceRegionAsync(System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetWebhookAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetGlobalApplicationCommandAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetGlobalApplicationCommandsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#StartAsync">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#StopAsync">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.ClientHelper.GetPrivateChannelsAsync(Discord.Rest.BaseDiscordClient,Discord.RequestOptions)">
- <exception cref="T:System.InvalidOperationException">Unexpected channel type.</exception>
- </member>
- <member name="T:Discord.Rest.DiscordRestClient">
- <summary>
- Provides a client to send REST-based requests to Discord.
- </summary>
- </member>
- <member name="P:Discord.Rest.DiscordRestClient.CurrentUser">
- <summary>
- Gets the logged-in user.
- </summary>
- </member>
- <member name="M:Discord.Rest.DiscordRestClient.#ctor">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.DiscordRestClient.#ctor(Discord.Rest.DiscordRestConfig)">
- <summary>
- Initializes a new <see cref="T:Discord.Rest.DiscordRestClient"/> with the provided configuration.
- </summary>
- <param name="config">The configuration to be used with the client.</param>
- </member>
- <member name="M:Discord.Rest.DiscordRestClient.OnLoginAsync(Discord.TokenType,System.String)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.DiscordRestClient.OnLogoutAsync">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetApplicationInfoAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetPrivateChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetDMChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetGroupChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetConnectionsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetGuildAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetGuildsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#CreateGuildAsync(System.String,Discord.IVoiceRegion,System.IO.Stream,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetVoiceRegionsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetVoiceRegionAsync(System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetWebhookAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetGlobalApplicationCommandsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetGlobalApplicationCommandAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="T:Discord.Rest.DiscordRestConfig">
- <summary>
- Represents a configuration class for <see cref="T:Discord.Rest.DiscordRestClient"/>.
- </summary>
- </member>
- <member name="P:Discord.Rest.DiscordRestConfig.RestClientProvider">
- <summary> Gets or sets the provider used to generate new REST connections. </summary>
- </member>
- <member name="T:Discord.Rest.BanAuditLogData">
- <summary>
- Contains a piece of audit log data related to a ban.
- </summary>
- </member>
- <member name="P:Discord.Rest.BanAuditLogData.Target">
- <summary>
- Gets the user that was banned.
- </summary>
- <returns>
- A user object representing the banned user.
- </returns>
- </member>
- <member name="T:Discord.Rest.BotAddAuditLogData">
- <summary>
- Contains a piece of audit log data related to a adding a bot to a guild.
- </summary>
- </member>
- <member name="P:Discord.Rest.BotAddAuditLogData.Target">
- <summary>
- Gets the bot that was added.
- </summary>
- <returns>
- A user object representing the bot.
- </returns>
- </member>
- <member name="T:Discord.Rest.ChannelCreateAuditLogData">
- <summary>
- Contains a piece of audit log data related to a channel creation.
- </summary>
- </member>
- <member name="P:Discord.Rest.ChannelCreateAuditLogData.ChannelId">
- <summary>
- Gets the snowflake ID of the created channel.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier for the created channel.
- </returns>
- </member>
- <member name="P:Discord.Rest.ChannelCreateAuditLogData.ChannelName">
- <summary>
- Gets the name of the created channel.
- </summary>
- <returns>
- A string containing the name of the created channel.
- </returns>
- </member>
- <member name="P:Discord.Rest.ChannelCreateAuditLogData.ChannelType">
- <summary>
- Gets the type of the created channel.
- </summary>
- <returns>
- The type of channel that was created.
- </returns>
- </member>
- <member name="P:Discord.Rest.ChannelCreateAuditLogData.SlowModeInterval">
- <summary>
- Gets the current slow-mode delay of the created channel.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> representing the time in seconds required before the user can send another
- message; <c>0</c> if disabled.
- <c>null</c> if this is not mentioned in this entry.
- </returns>
- </member>
- <member name="P:Discord.Rest.ChannelCreateAuditLogData.IsNsfw">
- <summary>
- Gets the value that indicates whether the created channel is NSFW.
- </summary>
- <returns>
- <c>true</c> if the created channel has the NSFW flag enabled; otherwise <c>false</c>.
- <c>null</c> if this is not mentioned in this entry.
- </returns>
- </member>
- <member name="P:Discord.Rest.ChannelCreateAuditLogData.Bitrate">
- <summary>
- Gets the bit-rate that the clients in the created voice channel are requested to use.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> representing the bit-rate (bps) that the created voice channel defines and requests the
- client(s) to use.
- <c>null</c> if this is not mentioned in this entry.
- </returns>
- </member>
- <member name="P:Discord.Rest.ChannelCreateAuditLogData.Overwrites">
- <summary>
- Gets a collection of permission overwrites that was assigned to the created channel.
- </summary>
- <returns>
- A collection of permission <see cref="T:Discord.Overwrite"/>, containing the permission overwrites that were
- assigned to the created channel.
- </returns>
- </member>
- <member name="T:Discord.Rest.ChannelDeleteAuditLogData">
- <summary>
- Contains a piece of audit log data related to a channel deletion.
- </summary>
- </member>
- <member name="P:Discord.Rest.ChannelDeleteAuditLogData.ChannelId">
- <summary>
- Gets the snowflake ID of the deleted channel.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier for the deleted channel.
- </returns>
- </member>
- <member name="P:Discord.Rest.ChannelDeleteAuditLogData.ChannelName">
- <summary>
- Gets the name of the deleted channel.
- </summary>
- <returns>
- A string containing the name of the deleted channel.
- </returns>
- </member>
- <member name="P:Discord.Rest.ChannelDeleteAuditLogData.ChannelType">
- <summary>
- Gets the type of the deleted channel.
- </summary>
- <returns>
- The type of channel that was deleted.
- </returns>
- </member>
- <member name="P:Discord.Rest.ChannelDeleteAuditLogData.SlowModeInterval">
- <summary>
- Gets the slow-mode delay of the deleted channel.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> representing the time in seconds required before the user can send another
- message; <c>0</c> if disabled.
- <c>null</c> if this is not mentioned in this entry.
- </returns>
- </member>
- <member name="P:Discord.Rest.ChannelDeleteAuditLogData.IsNsfw">
- <summary>
- Gets the value that indicates whether the deleted channel was NSFW.
- </summary>
- <returns>
- <c>true</c> if this channel had the NSFW flag enabled; otherwise <c>false</c>.
- <c>null</c> if this is not mentioned in this entry.
- </returns>
- </member>
- <member name="P:Discord.Rest.ChannelDeleteAuditLogData.Bitrate">
- <summary>
- Gets the bit-rate of this channel if applicable.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> representing the bit-rate set of the voice channel.
- <c>null</c> if this is not mentioned in this entry.
- </returns>
- </member>
- <member name="P:Discord.Rest.ChannelDeleteAuditLogData.Overwrites">
- <summary>
- Gets a collection of permission overwrites that was assigned to the deleted channel.
- </summary>
- <returns>
- A collection of permission <see cref="T:Discord.Overwrite"/>.
- </returns>
- </member>
- <member name="T:Discord.Rest.ChannelInfo">
- <summary>
- Represents information for a channel.
- </summary>
- </member>
- <member name="P:Discord.Rest.ChannelInfo.Name">
- <summary>
- Gets the name of this channel.
- </summary>
- <returns>
- A string containing the name of this channel.
- </returns>
- </member>
- <member name="P:Discord.Rest.ChannelInfo.Topic">
- <summary>
- Gets the topic of this channel.
- </summary>
- <returns>
- A string containing the topic of this channel, if any.
- </returns>
- </member>
- <member name="P:Discord.Rest.ChannelInfo.SlowModeInterval">
- <summary>
- Gets the current slow-mode delay of this channel.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> representing the time in seconds required before the user can send another
- message; <c>0</c> if disabled.
- <c>null</c> if this is not mentioned in this entry.
- </returns>
- </member>
- <member name="P:Discord.Rest.ChannelInfo.IsNsfw">
- <summary>
- Gets the value that indicates whether this channel is NSFW.
- </summary>
- <returns>
- <c>true</c> if this channel has the NSFW flag enabled; otherwise <c>false</c>.
- <c>null</c> if this is not mentioned in this entry.
- </returns>
- </member>
- <member name="P:Discord.Rest.ChannelInfo.Bitrate">
- <summary>
- Gets the bit-rate of this channel if applicable.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> representing the bit-rate set for the voice channel;
- <c>null</c> if this is not mentioned in this entry.
- </returns>
- </member>
- <member name="P:Discord.Rest.ChannelInfo.ChannelType">
- <summary>
- Gets the type of this channel.
- </summary>
- <returns>
- The channel type of this channel; <c>null</c> if not applicable.
- </returns>
- </member>
- <member name="T:Discord.Rest.ChannelUpdateAuditLogData">
- <summary>
- Contains a piece of audit log data related to a channel update.
- </summary>
- </member>
- <member name="P:Discord.Rest.ChannelUpdateAuditLogData.ChannelId">
- <summary>
- Gets the snowflake ID of the updated channel.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier for the updated channel.
- </returns>
- </member>
- <member name="P:Discord.Rest.ChannelUpdateAuditLogData.Before">
- <summary>
- Gets the channel information before the changes.
- </summary>
- <returns>
- An information object containing the original channel information before the changes were made.
- </returns>
- </member>
- <member name="P:Discord.Rest.ChannelUpdateAuditLogData.After">
- <summary>
- Gets the channel information after the changes.
- </summary>
- <returns>
- An information object containing the channel information after the changes were made.
- </returns>
- </member>
- <member name="T:Discord.Rest.EmoteCreateAuditLogData">
- <summary>
- Contains a piece of audit log data related to an emoji creation.
- </summary>
- </member>
- <member name="P:Discord.Rest.EmoteCreateAuditLogData.EmoteId">
- <summary>
- Gets the snowflake ID of the created emoji.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier for the created emoji.
- </returns>
- </member>
- <member name="P:Discord.Rest.EmoteCreateAuditLogData.Name">
- <summary>
- Gets the name of the created emoji.
- </summary>
- <returns>
- A string containing the name of the created emoji.
- </returns>
- </member>
- <member name="T:Discord.Rest.EmoteDeleteAuditLogData">
- <summary>
- Contains a piece of audit log data related to an emoji deletion.
- </summary>
- </member>
- <member name="P:Discord.Rest.EmoteDeleteAuditLogData.EmoteId">
- <summary>
- Gets the snowflake ID of the deleted emoji.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier for the deleted emoji.
- </returns>
- </member>
- <member name="P:Discord.Rest.EmoteDeleteAuditLogData.Name">
- <summary>
- Gets the name of the deleted emoji.
- </summary>
- <returns>
- A string containing the name of the deleted emoji.
- </returns>
- </member>
- <member name="T:Discord.Rest.EmoteUpdateAuditLogData">
- <summary>
- Contains a piece of audit log data related to an emoji update.
- </summary>
- </member>
- <member name="P:Discord.Rest.EmoteUpdateAuditLogData.EmoteId">
- <summary>
- Gets the snowflake ID of the updated emoji.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier of the updated emoji.
- </returns>
- </member>
- <member name="P:Discord.Rest.EmoteUpdateAuditLogData.NewName">
- <summary>
- Gets the new name of the updated emoji.
- </summary>
- <returns>
- A string containing the new name of the updated emoji.
- </returns>
- </member>
- <member name="P:Discord.Rest.EmoteUpdateAuditLogData.OldName">
- <summary>
- Gets the old name of the updated emoji.
- </summary>
- <returns>
- A string containing the old name of the updated emoji.
- </returns>
- </member>
- <member name="T:Discord.Rest.GuildInfo">
- <summary>
- Represents information for a guild.
- </summary>
- </member>
- <member name="P:Discord.Rest.GuildInfo.AfkTimeout">
- <summary>
- Gets the amount of time (in seconds) a user must be inactive in a voice channel for until they are
- automatically moved to the AFK voice channel.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> representing the amount of time in seconds for a user to be marked as inactive
- and moved into the AFK voice channel.
- <c>null</c> if this is not mentioned in this entry.
- </returns>
- </member>
- <member name="P:Discord.Rest.GuildInfo.DefaultMessageNotifications">
- <summary>
- Gets the default message notifications for users who haven't explicitly set their notification settings.
- </summary>
- <returns>
- The default message notifications setting of this guild.
- <c>null</c> if this is not mentioned in this entry.
- </returns>
- </member>
- <member name="P:Discord.Rest.GuildInfo.AfkChannelId">
- <summary>
- Gets the ID of the AFK voice channel for this guild.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier of the AFK voice channel; <c>null</c> if
- none is set.
- </returns>
- </member>
- <member name="P:Discord.Rest.GuildInfo.Name">
- <summary>
- Gets the name of this guild.
- </summary>
- <returns>
- A string containing the name of this guild.
- </returns>
- </member>
- <member name="P:Discord.Rest.GuildInfo.RegionId">
- <summary>
- Gets the ID of the region hosting this guild's voice channels.
- </summary>
- </member>
- <member name="P:Discord.Rest.GuildInfo.IconHash">
- <summary>
- Gets the ID of this guild's icon.
- </summary>
- <returns>
- A string containing the identifier for the splash image; <c>null</c> if none is set.
- </returns>
- </member>
- <member name="P:Discord.Rest.GuildInfo.VerificationLevel">
- <summary>
- Gets the level of requirements a user must fulfill before being allowed to post messages in this guild.
- </summary>
- <returns>
- The level of requirements.
- <c>null</c> if this is not mentioned in this entry.
- </returns>
- </member>
- <member name="P:Discord.Rest.GuildInfo.Owner">
- <summary>
- Gets the owner of this guild.
- </summary>
- <returns>
- A user object representing the owner of this guild.
- </returns>
- </member>
- <member name="P:Discord.Rest.GuildInfo.MfaLevel">
- <summary>
- Gets the level of Multi-Factor Authentication requirements a user must fulfill before being allowed to
- perform administrative actions in this guild.
- </summary>
- <returns>
- The level of MFA requirement.
- <c>null</c> if this is not mentioned in this entry.
- </returns>
- </member>
- <member name="P:Discord.Rest.GuildInfo.ExplicitContentFilter">
- <summary>
- Gets the level of content filtering applied to user's content in a Guild.
- </summary>
- <returns>
- The level of explicit content filtering.
- </returns>
- </member>
- <member name="P:Discord.Rest.GuildInfo.SystemChannelId">
- <summary>
- Gets the ID of the channel where system messages are sent.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier of the channel where system
- messages are sent; <c>null</c> if none is set.
- </returns>
- </member>
- <member name="P:Discord.Rest.GuildInfo.EmbedChannelId">
- <summary>
- Gets the ID of the widget embed channel of this guild.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier of the embedded channel found within the
- widget settings of this guild; <c>null</c> if none is set.
- </returns>
- </member>
- <member name="P:Discord.Rest.GuildInfo.IsEmbeddable">
- <summary>
- Gets a value that indicates whether this guild is embeddable (i.e. can use widget).
- </summary>
- <returns>
- <c>true</c> if this guild can be embedded via widgets; otherwise <c>false</c>.
- <c>null</c> if this is not mentioned in this entry.
- </returns>
- </member>
- <member name="T:Discord.Rest.GuildUpdateAuditLogData">
- <summary>
- Contains a piece of audit log data related to a guild update.
- </summary>
- </member>
- <member name="P:Discord.Rest.GuildUpdateAuditLogData.Before">
- <summary>
- Gets the guild information before the changes.
- </summary>
- <returns>
- An information object containing the original guild information before the changes were made.
- </returns>
- </member>
- <member name="P:Discord.Rest.GuildUpdateAuditLogData.After">
- <summary>
- Gets the guild information after the changes.
- </summary>
- <returns>
- An information object containing the guild information after the changes were made.
- </returns>
- </member>
- <member name="T:Discord.Rest.InviteCreateAuditLogData">
- <summary>
- Contains a piece of audit log data related to an invite creation.
- </summary>
- </member>
- <member name="P:Discord.Rest.InviteCreateAuditLogData.MaxAge">
- <summary>
- Gets the time (in seconds) until the invite expires.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> representing the time in seconds until this invite expires.
- </returns>
- </member>
- <member name="P:Discord.Rest.InviteCreateAuditLogData.Code">
- <summary>
- Gets the unique identifier for this invite.
- </summary>
- <returns>
- A string containing the invite code (e.g. <c>FTqNnyS</c>).
- </returns>
- </member>
- <member name="P:Discord.Rest.InviteCreateAuditLogData.Temporary">
- <summary>
- Gets a value that determines whether the invite is a temporary one.
- </summary>
- <returns>
- <c>true</c> if users accepting this invite will be removed from the guild when they log off; otherwise
- <c>false</c>.
- </returns>
- </member>
- <member name="P:Discord.Rest.InviteCreateAuditLogData.Creator">
- <summary>
- Gets the user that created this invite if available.
- </summary>
- <returns>
- A user that created this invite or <see langword="null"/>.
- </returns>
- </member>
- <member name="P:Discord.Rest.InviteCreateAuditLogData.ChannelId">
- <summary>
- Gets the ID of the channel this invite is linked to.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the channel snowflake identifier that the invite points to.
- </returns>
- </member>
- <member name="P:Discord.Rest.InviteCreateAuditLogData.Uses">
- <summary>
- Gets the number of times this invite has been used.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> representing the number of times this invite was used.
- </returns>
- </member>
- <member name="P:Discord.Rest.InviteCreateAuditLogData.MaxUses">
- <summary>
- Gets the max number of uses this invite may have.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> representing the number of uses this invite may be accepted until it is removed
- from the guild; <c>null</c> if none is set.
- </returns>
- </member>
- <member name="T:Discord.Rest.InviteDeleteAuditLogData">
- <summary>
- Contains a piece of audit log data related to an invite removal.
- </summary>
- </member>
- <member name="P:Discord.Rest.InviteDeleteAuditLogData.MaxAge">
- <summary>
- Gets the time (in seconds) until the invite expires.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> representing the time in seconds until this invite expires.
- </returns>
- </member>
- <member name="P:Discord.Rest.InviteDeleteAuditLogData.Code">
- <summary>
- Gets the unique identifier for this invite.
- </summary>
- <returns>
- A string containing the invite code (e.g. <c>FTqNnyS</c>).
- </returns>
- </member>
- <member name="P:Discord.Rest.InviteDeleteAuditLogData.Temporary">
- <summary>
- Gets a value that indicates whether the invite is a temporary one.
- </summary>
- <returns>
- <c>true</c> if users accepting this invite will be removed from the guild when they log off; otherwise
- <c>false</c>.
- </returns>
- </member>
- <member name="P:Discord.Rest.InviteDeleteAuditLogData.Creator">
- <summary>
- Gets the user that created this invite if available.
- </summary>
- <returns>
- A user that created this invite or <see langword="null"/>.
- </returns>
- </member>
- <member name="P:Discord.Rest.InviteDeleteAuditLogData.ChannelId">
- <summary>
- Gets the ID of the channel this invite is linked to.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the channel snowflake identifier that the invite points to.
- </returns>
- </member>
- <member name="P:Discord.Rest.InviteDeleteAuditLogData.Uses">
- <summary>
- Gets the number of times this invite has been used.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> representing the number of times this invite has been used.
- </returns>
- </member>
- <member name="P:Discord.Rest.InviteDeleteAuditLogData.MaxUses">
- <summary>
- Gets the max number of uses this invite may have.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> representing the number of uses this invite may be accepted until it is removed
- from the guild; <c>null</c> if none is set.
- </returns>
- </member>
- <member name="T:Discord.Rest.InviteInfo">
- <summary>
- Represents information for an invite.
- </summary>
- </member>
- <member name="P:Discord.Rest.InviteInfo.MaxAge">
- <summary>
- Gets the time (in seconds) until the invite expires.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> representing the time in seconds until this invite expires; <c>null</c> if this
- invite never expires or not specified.
- </returns>
- </member>
- <member name="P:Discord.Rest.InviteInfo.Code">
- <summary>
- Gets the unique identifier for this invite.
- </summary>
- <returns>
- A string containing the invite code (e.g. <c>FTqNnyS</c>).
- </returns>
- </member>
- <member name="P:Discord.Rest.InviteInfo.Temporary">
- <summary>
- Gets a value that indicates whether the invite is a temporary one.
- </summary>
- <returns>
- <c>true</c> if users accepting this invite will be removed from the guild when they log off,
- <c>false</c> if not; <c>null</c> if not specified.
- </returns>
- </member>
- <member name="P:Discord.Rest.InviteInfo.ChannelId">
- <summary>
- Gets the ID of the channel this invite is linked to.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the channel snowflake identifier that the invite points to;
- <c>null</c> if not specified.
- </returns>
- </member>
- <member name="P:Discord.Rest.InviteInfo.MaxUses">
- <summary>
- Gets the max number of uses this invite may have.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> representing the number of uses this invite may be accepted until it is removed
- from the guild; <c>null</c> if none is specified.
- </returns>
- </member>
- <member name="T:Discord.Rest.InviteUpdateAuditLogData">
- <summary>
- Contains a piece of audit log data relating to an invite update.
- </summary>
- </member>
- <member name="P:Discord.Rest.InviteUpdateAuditLogData.Before">
- <summary>
- Gets the invite information before the changes.
- </summary>
- <returns>
- An information object containing the original invite information before the changes were made.
- </returns>
- </member>
- <member name="P:Discord.Rest.InviteUpdateAuditLogData.After">
- <summary>
- Gets the invite information after the changes.
- </summary>
- <returns>
- An information object containing the invite information after the changes were made.
- </returns>
- </member>
- <member name="T:Discord.Rest.KickAuditLogData">
- <summary>
- Contains a piece of audit log data related to a kick.
- </summary>
- </member>
- <member name="P:Discord.Rest.KickAuditLogData.Target">
- <summary>
- Gets the user that was kicked.
- </summary>
- <returns>
- A user object representing the kicked user.
- </returns>
- </member>
- <member name="T:Discord.Rest.MemberDisconnectAuditLogData">
- <summary>
- Contains a piece of audit log data related to disconnecting members from voice channels.
- </summary>
- </member>
- <member name="P:Discord.Rest.MemberDisconnectAuditLogData.MemberCount">
- <summary>
- Gets the number of members that were disconnected.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> representing the number of members that were disconnected from a voice channel.
- </returns>
- </member>
- <member name="T:Discord.Rest.MemberInfo">
- <summary>
- Represents information for a member.
- </summary>
- </member>
- <member name="P:Discord.Rest.MemberInfo.Nickname">
- <summary>
- Gets the nickname of the updated member.
- </summary>
- <returns>
- A string representing the nickname of the updated member; <c>null</c> if none is set.
- </returns>
- </member>
- <member name="P:Discord.Rest.MemberInfo.Deaf">
- <summary>
- Gets a value that indicates whether the updated member is deafened by the guild.
- </summary>
- <returns>
- <c>true</c> if the updated member is deafened (i.e. not permitted to listen to or speak to others) by the guild;
- otherwise <c>false</c>.
- <c>null</c> if this is not mentioned in this entry.
- </returns>
- </member>
- <member name="P:Discord.Rest.MemberInfo.Mute">
- <summary>
- Gets a value that indicates whether the updated member is muted (i.e. not permitted to speak via voice) by the
- guild.
- </summary>
- <returns>
- <c>true</c> if the updated member is muted by the guild; otherwise <c>false</c>.
- <c>null</c> if this is not mentioned in this entry.
- </returns>
- </member>
- <member name="T:Discord.Rest.MemberMoveAuditLogData">
- <summary>
- Contains a piece of audit log data related to moving members between voice channels.
- </summary>
- </member>
- <member name="P:Discord.Rest.MemberMoveAuditLogData.ChannelId">
- <summary>
- Gets the ID of the channel that the members were moved to.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier for the channel that the members were moved to.
- </returns>
- </member>
- <member name="P:Discord.Rest.MemberMoveAuditLogData.MemberCount">
- <summary>
- Gets the number of members that were moved.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> representing the number of members that were moved to another voice channel.
- </returns>
- </member>
- <member name="T:Discord.Rest.MemberRoleAuditLogData">
- <summary>
- Contains a piece of audit log data related to a change in a guild member's roles.
- </summary>
- </member>
- <member name="P:Discord.Rest.MemberRoleAuditLogData.Roles">
- <summary>
- Gets a collection of role changes that were performed on the member.
- </summary>
- <returns>
- A read-only collection of <see cref="T:Discord.Rest.MemberRoleEditInfo"/>, containing the roles that were changed on
- the member.
- </returns>
- </member>
- <member name="P:Discord.Rest.MemberRoleAuditLogData.Target">
- <summary>
- Gets the user that the roles changes were performed on.
- </summary>
- <returns>
- A user object representing the user that the role changes were performed on.
- </returns>
- </member>
- <member name="T:Discord.Rest.MemberRoleEditInfo">
- <summary>
- An information object representing a change in one of a guild member's roles.
- </summary>
- </member>
- <member name="P:Discord.Rest.MemberRoleEditInfo.Name">
- <summary>
- Gets the name of the role that was changed.
- </summary>
- <returns>
- A string containing the name of the role that was changed.
- </returns>
- </member>
- <member name="P:Discord.Rest.MemberRoleEditInfo.RoleId">
- <summary>
- Gets the ID of the role that was changed.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier of the role that was changed.
- </returns>
- </member>
- <member name="P:Discord.Rest.MemberRoleEditInfo.Added">
- <summary>
- Gets a value that indicates whether the role was added to the user.
- </summary>
- <returns>
- <c>true</c> if the role was added to the user; otherwise <c>false</c>.
- </returns>
- </member>
- <member name="T:Discord.Rest.MemberUpdateAuditLogData">
- <summary>
- Contains a piece of audit log data related to a change in a guild member.
- </summary>
- </member>
- <member name="P:Discord.Rest.MemberUpdateAuditLogData.Target">
- <summary>
- Gets the user that the changes were performed on.
- </summary>
- <returns>
- A user object representing the user who the changes were performed on.
- </returns>
- </member>
- <member name="P:Discord.Rest.MemberUpdateAuditLogData.Before">
- <summary>
- Gets the member information before the changes.
- </summary>
- <returns>
- An information object containing the original member information before the changes were made.
- </returns>
- </member>
- <member name="P:Discord.Rest.MemberUpdateAuditLogData.After">
- <summary>
- Gets the member information after the changes.
- </summary>
- <returns>
- An information object containing the member information after the changes were made.
- </returns>
- </member>
- <member name="T:Discord.Rest.MessageBulkDeleteAuditLogData">
- <summary>
- Contains a piece of audit log data related to message deletion(s).
- </summary>
- </member>
- <member name="P:Discord.Rest.MessageBulkDeleteAuditLogData.ChannelId">
- <summary>
- Gets the ID of the channel that the messages were deleted from.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier for the channel that the messages were
- deleted from.
- </returns>
- </member>
- <member name="P:Discord.Rest.MessageBulkDeleteAuditLogData.MessageCount">
- <summary>
- Gets the number of messages that were deleted.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> representing the number of messages that were deleted from the channel.
- </returns>
- </member>
- <member name="T:Discord.Rest.MessageDeleteAuditLogData">
- <summary>
- Contains a piece of audit log data related to message deletion(s).
- </summary>
- </member>
- <member name="P:Discord.Rest.MessageDeleteAuditLogData.MessageCount">
- <summary>
- Gets the number of messages that were deleted.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> representing the number of messages that were deleted from the channel.
- </returns>
- </member>
- <member name="P:Discord.Rest.MessageDeleteAuditLogData.ChannelId">
- <summary>
- Gets the ID of the channel that the messages were deleted from.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier for the channel that the messages were
- deleted from.
- </returns>
- </member>
- <member name="P:Discord.Rest.MessageDeleteAuditLogData.Target">
- <summary>
- Gets the user of the messages that were deleted.
- </summary>
- <returns>
- A user object representing the user that created the deleted messages.
- </returns>
- </member>
- <member name="T:Discord.Rest.MessagePinAuditLogData">
- <summary>
- Contains a piece of audit log data related to a pinned message.
- </summary>
- </member>
- <member name="P:Discord.Rest.MessagePinAuditLogData.MessageId">
- <summary>
- Gets the ID of the messages that was pinned.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier for the messages that was pinned.
- </returns>
- </member>
- <member name="P:Discord.Rest.MessagePinAuditLogData.ChannelId">
- <summary>
- Gets the ID of the channel that the message was pinned from.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier for the channel that the message was pinned from.
- </returns>
- </member>
- <member name="P:Discord.Rest.MessagePinAuditLogData.Target">
- <summary>
- Gets the user of the message that was pinned if available.
- </summary>
- <returns>
- A user object representing the user that created the pinned message or <see langword="null"/>.
- </returns>
- </member>
- <member name="T:Discord.Rest.MessageUnpinAuditLogData">
- <summary>
- Contains a piece of audit log data related to an unpinned message.
- </summary>
- </member>
- <member name="P:Discord.Rest.MessageUnpinAuditLogData.MessageId">
- <summary>
- Gets the ID of the messages that was unpinned.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier for the messages that was unpinned.
- </returns>
- </member>
- <member name="P:Discord.Rest.MessageUnpinAuditLogData.ChannelId">
- <summary>
- Gets the ID of the channel that the message was unpinned from.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier for the channel that the message was unpinned from.
- </returns>
- </member>
- <member name="P:Discord.Rest.MessageUnpinAuditLogData.Target">
- <summary>
- Gets the user of the message that was unpinned if available.
- </summary>
- <returns>
- A user object representing the user that created the unpinned message or <see langword="null"/>.
- </returns>
- </member>
- <member name="T:Discord.Rest.OverwriteCreateAuditLogData">
- <summary>
- Contains a piece of audit log data for a permissions overwrite creation.
- </summary>
- </member>
- <member name="P:Discord.Rest.OverwriteCreateAuditLogData.ChannelId">
- <summary>
- Gets the ID of the channel that the overwrite was created from.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier for the channel that the overwrite was
- created from.
- </returns>
- </member>
- <member name="P:Discord.Rest.OverwriteCreateAuditLogData.Overwrite">
- <summary>
- Gets the permission overwrite object that was created.
- </summary>
- <returns>
- An <see cref="P:Discord.Rest.OverwriteCreateAuditLogData.Overwrite"/> object representing the overwrite that was created.
- </returns>
- </member>
- <member name="T:Discord.Rest.OverwriteDeleteAuditLogData">
- <summary>
- Contains a piece of audit log data related to the deletion of a permission overwrite.
- </summary>
- </member>
- <member name="P:Discord.Rest.OverwriteDeleteAuditLogData.ChannelId">
- <summary>
- Gets the ID of the channel that the overwrite was deleted from.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier for the channel that the overwrite was
- deleted from.
- </returns>
- </member>
- <member name="P:Discord.Rest.OverwriteDeleteAuditLogData.Overwrite">
- <summary>
- Gets the permission overwrite object that was deleted.
- </summary>
- <returns>
- An <see cref="P:Discord.Rest.OverwriteDeleteAuditLogData.Overwrite"/> object representing the overwrite that was deleted.
- </returns>
- </member>
- <member name="T:Discord.Rest.OverwriteUpdateAuditLogData">
- <summary>
- Contains a piece of audit log data related to the update of a permission overwrite.
- </summary>
- </member>
- <member name="P:Discord.Rest.OverwriteUpdateAuditLogData.ChannelId">
- <summary>
- Gets the ID of the channel that the overwrite was updated from.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier for the channel that the overwrite was
- updated from.
- </returns>
- </member>
- <member name="P:Discord.Rest.OverwriteUpdateAuditLogData.OldPermissions">
- <summary>
- Gets the overwrite permissions before the changes.
- </summary>
- <returns>
- An overwrite permissions object representing the overwrite permissions that the overwrite had before
- the changes were made.
- </returns>
- </member>
- <member name="P:Discord.Rest.OverwriteUpdateAuditLogData.NewPermissions">
- <summary>
- Gets the overwrite permissions after the changes.
- </summary>
- <returns>
- An overwrite permissions object representing the overwrite permissions that the overwrite had after the
- changes.
- </returns>
- </member>
- <member name="P:Discord.Rest.OverwriteUpdateAuditLogData.OverwriteTargetId">
- <summary>
- Gets the ID of the overwrite that was updated.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier of the overwrite that was updated.
- </returns>
- </member>
- <member name="P:Discord.Rest.OverwriteUpdateAuditLogData.OverwriteType">
- <summary>
- Gets the target of the updated permission overwrite.
- </summary>
- <returns>
- The target of the updated permission overwrite.
- </returns>
- </member>
- <member name="T:Discord.Rest.PruneAuditLogData">
- <summary>
- Contains a piece of audit log data related to a guild prune.
- </summary>
- </member>
- <member name="P:Discord.Rest.PruneAuditLogData.PruneDays">
- <summary>
- Gets the threshold for a guild member to not be kicked.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> representing the amount of days that a member must have been seen in the server,
- to avoid being kicked. (i.e. If a user has not been seen for more than <paramref cref="P:Discord.Rest.PruneAuditLogData.PruneDays"/>, they will be
- kicked from the server)
- </returns>
- </member>
- <member name="P:Discord.Rest.PruneAuditLogData.MembersRemoved">
- <summary>
- Gets the number of members that were kicked during the purge.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> representing the number of members that were removed from this guild for having
- not been seen within <paramref cref="P:Discord.Rest.PruneAuditLogData.PruneDays"/>.
- </returns>
- </member>
- <member name="T:Discord.Rest.RoleCreateAuditLogData">
- <summary>
- Contains a piece of audit log data related to a role creation.
- </summary>
- </member>
- <member name="P:Discord.Rest.RoleCreateAuditLogData.RoleId">
- <summary>
- Gets the ID of the role that was created.
- </summary>
- <return>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier to the role that was created.
- </return>
- </member>
- <member name="P:Discord.Rest.RoleCreateAuditLogData.Properties">
- <summary>
- Gets the role information that was created.
- </summary>
- <return>
- An information object representing the properties of the role that was created.
- </return>
- </member>
- <member name="T:Discord.Rest.RoleDeleteAuditLogData">
- <summary>
- Contains a piece of audit log data relating to a role deletion.
- </summary>
- </member>
- <member name="P:Discord.Rest.RoleDeleteAuditLogData.RoleId">
- <summary>
- Gets the ID of the role that was deleted.
- </summary>
- <return>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier to the role that was deleted.
- </return>
- </member>
- <member name="P:Discord.Rest.RoleDeleteAuditLogData.Properties">
- <summary>
- Gets the role information that was deleted.
- </summary>
- <return>
- An information object representing the properties of the role that was deleted.
- </return>
- </member>
- <member name="T:Discord.Rest.RoleEditInfo">
- <summary>
- Represents information for a role edit.
- </summary>
- </member>
- <member name="P:Discord.Rest.RoleEditInfo.Color">
- <summary>
- Gets the color of this role.
- </summary>
- <returns>
- A color object representing the color assigned to this role; <c>null</c> if this role does not have a
- color.
- </returns>
- </member>
- <member name="P:Discord.Rest.RoleEditInfo.Mentionable">
- <summary>
- Gets a value that indicates whether this role is mentionable.
- </summary>
- <returns>
- <c>true</c> if other members can mention this role in a text channel; otherwise <c>false</c>;
- <c>null</c> if this is not mentioned in this entry.
- </returns>
- </member>
- <member name="P:Discord.Rest.RoleEditInfo.Hoist">
- <summary>
- Gets a value that indicates whether this role is hoisted (i.e. its members will appear in a separate
- section on the user list).
- </summary>
- <returns>
- <c>true</c> if this role's members will appear in a separate section in the user list; otherwise
- <c>false</c>; <c>null</c> if this is not mentioned in this entry.
- </returns>
- </member>
- <member name="P:Discord.Rest.RoleEditInfo.Name">
- <summary>
- Gets the name of this role.
- </summary>
- <returns>
- A string containing the name of this role.
- </returns>
- </member>
- <member name="P:Discord.Rest.RoleEditInfo.Permissions">
- <summary>
- Gets the permissions assigned to this role.
- </summary>
- <returns>
- A guild permissions object representing the permissions that have been assigned to this role; <c>null</c>
- if no permissions have been assigned.
- </returns>
- </member>
- <member name="T:Discord.Rest.RoleUpdateAuditLogData">
- <summary>
- Contains a piece of audit log data related to a role update.
- </summary>
- </member>
- <member name="P:Discord.Rest.RoleUpdateAuditLogData.RoleId">
- <summary>
- Gets the ID of the role that was changed.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier of the role that was changed.
- </returns>
- </member>
- <member name="P:Discord.Rest.RoleUpdateAuditLogData.Before">
- <summary>
- Gets the role information before the changes.
- </summary>
- <returns>
- A role information object containing the role information before the changes were made.
- </returns>
- </member>
- <member name="P:Discord.Rest.RoleUpdateAuditLogData.After">
- <summary>
- Gets the role information after the changes.
- </summary>
- <returns>
- A role information object containing the role information after the changes were made.
- </returns>
- </member>
- <member name="T:Discord.Rest.UnbanAuditLogData">
- <summary>
- Contains a piece of audit log data related to an unban.
- </summary>
- </member>
- <member name="P:Discord.Rest.UnbanAuditLogData.Target">
- <summary>
- Gets the user that was unbanned.
- </summary>
- <returns>
- A user object representing the user that was unbanned.
- </returns>
- </member>
- <member name="T:Discord.Rest.WebhookCreateAuditLogData">
- <summary>
- Contains a piece of audit log data related to a webhook creation.
- </summary>
- </member>
- <member name="P:Discord.Rest.WebhookCreateAuditLogData.Webhook">
- <summary>
- Gets the webhook that was created if it still exists.
- </summary>
- <returns>
- A webhook object representing the webhook that was created if it still exists, otherwise returns <c>null</c>.
- </returns>
- </member>
- <member name="P:Discord.Rest.WebhookCreateAuditLogData.WebhookId">
- <summary>
- Gets the webhook id.
- </summary>
- <returns>
- The webhook identifier.
- </returns>
- </member>
- <member name="P:Discord.Rest.WebhookCreateAuditLogData.Type">
- <summary>
- Gets the type of webhook that was created.
- </summary>
- <returns>
- The type of webhook that was created.
- </returns>
- </member>
- <member name="P:Discord.Rest.WebhookCreateAuditLogData.Name">
- <summary>
- Gets the name of the webhook.
- </summary>
- <returns>
- A string containing the name of the webhook.
- </returns>
- </member>
- <member name="P:Discord.Rest.WebhookCreateAuditLogData.ChannelId">
- <summary>
- Gets the ID of the channel that the webhook could send to.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier of the channel that the webhook could send
- to.
- </returns>
- </member>
- <member name="T:Discord.Rest.WebhookDeleteAuditLogData">
- <summary>
- Contains a piece of audit log data related to a webhook deletion.
- </summary>
- </member>
- <member name="P:Discord.Rest.WebhookDeleteAuditLogData.WebhookId">
- <summary>
- Gets the ID of the webhook that was deleted.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier of the webhook that was deleted.
- </returns>
- </member>
- <member name="P:Discord.Rest.WebhookDeleteAuditLogData.ChannelId">
- <summary>
- Gets the ID of the channel that the webhook could send to.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier of the channel that the webhook could send
- to.
- </returns>
- </member>
- <member name="P:Discord.Rest.WebhookDeleteAuditLogData.Type">
- <summary>
- Gets the type of the webhook that was deleted.
- </summary>
- <returns>
- The type of webhook that was deleted.
- </returns>
- </member>
- <member name="P:Discord.Rest.WebhookDeleteAuditLogData.Name">
- <summary>
- Gets the name of the webhook that was deleted.
- </summary>
- <returns>
- A string containing the name of the webhook that was deleted.
- </returns>
- </member>
- <member name="P:Discord.Rest.WebhookDeleteAuditLogData.Avatar">
- <summary>
- Gets the hash value of the webhook's avatar.
- </summary>
- <returns>
- A string containing the hash of the webhook's avatar.
- </returns>
- </member>
- <member name="T:Discord.Rest.WebhookInfo">
- <summary>
- Represents information for a webhook.
- </summary>
- </member>
- <member name="P:Discord.Rest.WebhookInfo.Name">
- <summary>
- Gets the name of this webhook.
- </summary>
- <returns>
- A string containing the name of this webhook.
- </returns>
- </member>
- <member name="P:Discord.Rest.WebhookInfo.ChannelId">
- <summary>
- Gets the ID of the channel that this webhook sends to.
- </summary>
- <returns>
- A <see cref="T:System.UInt64"/> representing the snowflake identifier of the channel that this webhook can send
- to.
- </returns>
- </member>
- <member name="P:Discord.Rest.WebhookInfo.Avatar">
- <summary>
- Gets the hash value of this webhook's avatar.
- </summary>
- <returns>
- A string containing the hash of this webhook's avatar.
- </returns>
- </member>
- <member name="T:Discord.Rest.WebhookUpdateAuditLogData">
- <summary>
- Contains a piece of audit log data related to a webhook update.
- </summary>
- </member>
- <member name="P:Discord.Rest.WebhookUpdateAuditLogData.Webhook">
- <summary>
- Gets the webhook that was updated.
- </summary>
- <returns>
- A webhook object representing the webhook that was updated.
- </returns>
- </member>
- <member name="P:Discord.Rest.WebhookUpdateAuditLogData.Before">
- <summary>
- Gets the webhook information before the changes.
- </summary>
- <returns>
- A webhook information object representing the webhook before the changes were made.
- </returns>
- </member>
- <member name="P:Discord.Rest.WebhookUpdateAuditLogData.After">
- <summary>
- Gets the webhook information after the changes.
- </summary>
- <returns>
- A webhook information object representing the webhook after the changes were made.
- </returns>
- </member>
- <member name="T:Discord.Rest.RestAuditLogEntry">
- <summary>
- Represents a REST-based audit log entry.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestAuditLogEntry.CreatedAt">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestAuditLogEntry.Action">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestAuditLogEntry.Data">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestAuditLogEntry.User">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestAuditLogEntry.Reason">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.ChannelHelper.CreateInviteAsync(Discord.IGuildChannel,Discord.Rest.BaseDiscordClient,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
- <exception cref="T:System.ArgumentException">
- <paramref name="channel.Id.Id"/> may not be equal to zero.
- -and-
- <paramref name="maxAge"/> and <paramref name="maxUses"/> must be greater than zero.
- -and-
- <paramref name="maxAge"/> must be lesser than 86400.
- </exception>
- </member>
- <member name="M:Discord.Rest.ChannelHelper.CreateInviteToStreamAsync(Discord.IGuildChannel,Discord.Rest.BaseDiscordClient,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.IUser,Discord.RequestOptions)">
- <exception cref="T:System.ArgumentException">
- <paramref name="channel.Id.Id"/> may not be equal to zero.
- -and-
- <paramref name="maxAge"/> and <paramref name="maxUses"/> must be greater than zero.
- -and-
- <paramref name="maxAge"/> must be lesser than 86400.
- </exception>
- </member>
- <member name="M:Discord.Rest.ChannelHelper.CreateInviteToApplicationAsync(Discord.IGuildChannel,Discord.Rest.BaseDiscordClient,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,System.UInt64,Discord.RequestOptions)">
- <exception cref="T:System.ArgumentException">
- <paramref name="channel.Id.Id"/> may not be equal to zero.
- -and-
- <paramref name="maxAge"/> and <paramref name="maxUses"/> must be greater than zero.
- -and-
- <paramref name="maxAge"/> must be lesser than 86400.
- </exception>
- </member>
- <member name="M:Discord.Rest.ChannelHelper.SendMessageAsync(Discord.IMessageChannel,Discord.Rest.BaseDiscordClient,System.String,System.Boolean,Discord.Embed,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[],Discord.RequestOptions)">
- <exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
- </member>
- <member name="M:Discord.Rest.ChannelHelper.SendFileAsync(Discord.IMessageChannel,Discord.Rest.BaseDiscordClient,System.String,System.String,System.Boolean,Discord.Embed,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[],Discord.RequestOptions,System.Boolean)">
- <exception cref="T:System.ArgumentException">
- <paramref name="filePath" /> is a zero-length string, contains only white space, or contains one or more
- invalid characters as defined by <see cref="M:System.IO.Path.GetInvalidPathChars"/>.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="filePath" /> is <c>null</c>.
- </exception>
- <exception cref="T:System.IO.PathTooLongException">
- The specified path, file name, or both exceed the system-defined maximum length. For example, on
- Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260
- characters.
- </exception>
- <exception cref="T:System.IO.DirectoryNotFoundException">
- The specified path is invalid, (for example, it is on an unmapped drive).
- </exception>
- <exception cref="T:System.UnauthorizedAccessException">
- <paramref name="filePath" /> specified a directory.-or- The caller does not have the required permission.
- </exception>
- <exception cref="T:System.IO.FileNotFoundException">
- The file specified in <paramref name="filePath" /> was not found.
- </exception>
- <exception cref="T:System.NotSupportedException"><paramref name="filePath" /> is in an invalid format.</exception>
- <exception cref="T:System.IO.IOException">An I/O error occurred while opening the file.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
- </member>
- <member name="M:Discord.Rest.ChannelHelper.SendFileAsync(Discord.IMessageChannel,Discord.Rest.BaseDiscordClient,System.IO.Stream,System.String,System.String,System.Boolean,Discord.Embed,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[],Discord.RequestOptions,System.Boolean)">
- <exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
- </member>
- <member name="M:Discord.Rest.ChannelHelper.GetUserAsync(Discord.IGuildChannel,Discord.IGuild,Discord.Rest.BaseDiscordClient,System.UInt64,Discord.RequestOptions)">
- <exception cref="T:System.InvalidOperationException">Resolving permissions requires the parent guild to be downloaded.</exception>
- </member>
- <member name="M:Discord.Rest.ChannelHelper.GetUsersAsync(Discord.IGuildChannel,Discord.IGuild,Discord.Rest.BaseDiscordClient,System.Nullable{System.UInt64},System.Nullable{System.Int32},Discord.RequestOptions)">
- <exception cref="T:System.InvalidOperationException">Resolving permissions requires the parent guild to be downloaded.</exception>
- </member>
- <member name="M:Discord.Rest.ChannelHelper.SyncPermissionsAsync(Discord.INestedChannel,Discord.Rest.BaseDiscordClient,Discord.RequestOptions)">
- <exception cref="T:System.InvalidOperationException">This channel does not have a parent channel.</exception>
- </member>
- <member name="T:Discord.Rest.IRestMessageChannel">
- <summary>
- Represents a REST-based channel that can send and receive messages.
- </summary>
- </member>
- <member name="M:Discord.Rest.IRestMessageChannel.SendMessageAsync(System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[])">
- <summary>
- Sends a message to this message channel.
- </summary>
- <remarks>
- This method follows the same behavior as described in <see cref="M:Discord.IMessageChannel.SendMessageAsync(System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[])"/>.
- Please visit its documentation for more details on this method.
- </remarks>
- <param name="text">The message to be sent.</param>
- <param name="isTTS">Determines whether the message should be read aloud by Discord or not.</param>
- <param name="embed">The <see cref="F:Discord.EmbedType.Rich"/> <see cref="T:Discord.Embed"/> to be sent.</param>
- <param name="options">The options to be used when sending the request.</param>
- <param name="allowedMentions">
- Specifies if notifications are sent for mentioned users and roles in the message <paramref name="text"/>.
- If <c>null</c>, all mentioned roles and users will be notified.
- </param>
- <param name="messageReference">The message references to be included. Used to reply to specific messages.</param>
- <param name="component">The message components to be included with this message. Used for interactions</param>
- <param name="stickers">A collection of stickers to send with the message.</param>
- <returns>
- A task that represents an asynchronous send operation for delivering the message. The task result
- contains the sent message.
- </returns>
- </member>
- <member name="M:Discord.Rest.IRestMessageChannel.SendFileAsync(System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[])">
- <summary>
- Sends a file to this message channel with an optional caption.
- </summary>
- <remarks>
- This method follows the same behavior as described in
- <see cref="M:Discord.IMessageChannel.SendFileAsync(System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[])"/>. Please visit
- its documentation for more details on this method.
- </remarks>
- <param name="filePath">The file path of the file.</param>
- <param name="text">The message to be sent.</param>
- <param name="isTTS">Whether the message should be read aloud by Discord or not.</param>
- <param name="embed">The <see cref="F:Discord.EmbedType.Rich" /> <see cref="T:Discord.Embed" /> to be sent.</param>
- <param name="options">The options to be used when sending the request.</param>
- <param name="isSpoiler">Whether the message attachment should be hidden as a spoiler.</param>
- <param name="allowedMentions">
- Specifies if notifications are sent for mentioned users and roles in the message <paramref name="text"/>.
- If <c>null</c>, all mentioned roles and users will be notified.
- </param>
- <param name="messageReference">The message references to be included. Used to reply to specific messages.</param>
- <param name="component">The message components to be included with this message. Used for interactions</param>
- <param name="stickers">A collection of stickers to send with the message.</param>
- <returns>
- A task that represents an asynchronous send operation for delivering the message. The task result
- contains the sent message.
- </returns>
- </member>
- <member name="M:Discord.Rest.IRestMessageChannel.SendFileAsync(System.IO.Stream,System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[])">
- <summary>
- Sends a file to this message channel with an optional caption.
- </summary>
- <remarks>
- This method follows the same behavior as described in <see cref="M:Discord.IMessageChannel.SendFileAsync(System.IO.Stream,System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[])"/>.
- Please visit its documentation for more details on this method.
- </remarks>
- <param name="stream">The <see cref="T:System.IO.Stream" /> of the file to be sent.</param>
- <param name="filename">The name of the attachment.</param>
- <param name="text">The message to be sent.</param>
- <param name="isTTS">Whether the message should be read aloud by Discord or not.</param>
- <param name="embed">The <see cref="F:Discord.EmbedType.Rich"/> <see cref="T:Discord.Embed"/> to be sent.</param>
- <param name="options">The options to be used when sending the request.</param>
- <param name="isSpoiler">Whether the message attachment should be hidden as a spoiler.</param>
- <param name="allowedMentions">
- Specifies if notifications are sent for mentioned users and roles in the message <paramref name="text"/>.
- If <c>null</c>, all mentioned roles and users will be notified.
- </param>
- <param name="messageReference">The message references to be included. Used to reply to specific messages.</param>
- <param name="component">The message components to be included with this message. Used for interactions</param>
- <param name="stickers">A collection of stickers to send with the message.</param>
- <returns>
- A task that represents an asynchronous send operation for delivering the message. The task result
- contains the sent message.
- </returns>
- </member>
- <member name="M:Discord.Rest.IRestMessageChannel.GetMessageAsync(System.UInt64,Discord.RequestOptions)">
- <summary>
- Gets a message from this message channel.
- </summary>
- <remarks>
- This method follows the same behavior as described in <see cref="M:Discord.IMessageChannel.GetMessageAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)"/>.
- Please visit its documentation for more details on this method.
- </remarks>
- <param name="id">The snowflake identifier of the message.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents an asynchronous get operation for retrieving the message. The task result contains
- the retrieved message; <c>null</c> if no message is found with the specified identifier.
- </returns>
- </member>
- <member name="M:Discord.Rest.IRestMessageChannel.GetMessagesAsync(System.Int32,Discord.RequestOptions)">
- <summary>
- Gets the last N messages from this message channel.
- </summary>
- <remarks>
- This method follows the same behavior as described in <see cref="M:Discord.IMessageChannel.GetMessagesAsync(System.Int32,Discord.CacheMode,Discord.RequestOptions)"/>.
- Please visit its documentation for more details on this method.
- </remarks>
- <param name="limit">The numbers of message to be gotten from.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- Paged collection of messages.
- </returns>
- </member>
- <member name="M:Discord.Rest.IRestMessageChannel.GetMessagesAsync(System.UInt64,Discord.Direction,System.Int32,Discord.RequestOptions)">
- <summary>
- Gets a collection of messages in this channel.
- </summary>
- <remarks>
- This method follows the same behavior as described in <see cref="M:Discord.IMessageChannel.GetMessagesAsync(System.UInt64,Discord.Direction,System.Int32,Discord.CacheMode,Discord.RequestOptions)"/>.
- Please visit its documentation for more details on this method.
- </remarks>
- <param name="fromMessageId">The ID of the starting message to get the messages from.</param>
- <param name="dir">The direction of the messages to be gotten from.</param>
- <param name="limit">The numbers of message to be gotten from.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- Paged collection of messages.
- </returns>
- </member>
- <member name="M:Discord.Rest.IRestMessageChannel.GetMessagesAsync(Discord.IMessage,Discord.Direction,System.Int32,Discord.RequestOptions)">
- <summary>
- Gets a collection of messages in this channel.
- </summary>
- <remarks>
- This method follows the same behavior as described in <see cref="M:Discord.IMessageChannel.GetMessagesAsync(Discord.IMessage,Discord.Direction,System.Int32,Discord.CacheMode,Discord.RequestOptions)"/>.
- Please visit its documentation for more details on this method.
- </remarks>
- <param name="fromMessage">The starting message to get the messages from.</param>
- <param name="dir">The direction of the messages to be gotten from.</param>
- <param name="limit">The numbers of message to be gotten from.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- Paged collection of messages.
- </returns>
- </member>
- <member name="M:Discord.Rest.IRestMessageChannel.GetPinnedMessagesAsync(Discord.RequestOptions)">
- <summary>
- Gets a collection of pinned messages in this channel.
- </summary>
- <remarks>
- This method follows the same behavior as described in <see cref="M:Discord.IMessageChannel.GetPinnedMessagesAsync(Discord.RequestOptions)"/>.
- Please visit its documentation for more details on this method.
- </remarks>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation for retrieving pinned messages in this channel.
- The task result contains a collection of messages found in the pinned messages.
- </returns>
- </member>
- <member name="T:Discord.Rest.IRestPrivateChannel">
- <summary>
- Represents a REST-based channel that is private to select recipients.
- </summary>
- </member>
- <member name="P:Discord.Rest.IRestPrivateChannel.Recipients">
- <summary>
- Users that can access this channel.
- </summary>
- </member>
- <member name="T:Discord.Rest.RestCategoryChannel">
- <summary>
- Represents a REST-based category channel.
- </summary>
- </member>
- <member name="M:Discord.Rest.RestCategoryChannel.Discord#IChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- <exception cref="T:System.NotSupportedException">This method is not supported with category channels.</exception>
- </member>
- <member name="M:Discord.Rest.RestCategoryChannel.Discord#IChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- <exception cref="T:System.NotSupportedException">This method is not supported with category channels.</exception>
- </member>
- <member name="T:Discord.Rest.RestChannel">
- <summary>
- Represents a generic REST-based channel.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestChannel.CreatedAt">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestChannel.Create(Discord.Rest.BaseDiscordClient,Discord.API.Channel)">
- <exception cref="T:System.InvalidOperationException">Unexpected channel type.</exception>
- </member>
- <member name="M:Discord.Rest.RestChannel.CreatePrivate(Discord.Rest.BaseDiscordClient,Discord.API.Channel)">
- <exception cref="T:System.InvalidOperationException">Unexpected channel type.</exception>
- </member>
- <member name="M:Discord.Rest.RestChannel.UpdateAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestChannel.Discord#IChannel#Name">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestChannel.Discord#IChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestChannel.Discord#IChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="T:Discord.Rest.RestDMChannel">
- <summary>
- Represents a REST-based direct-message channel.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestDMChannel.CurrentUser">
- <summary>
- Gets the current logged-in user.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestDMChannel.Recipient">
- <summary>
- Gets the recipient of the channel.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestDMChannel.Users">
- <summary>
- Gets a collection that is the current logged-in user and the recipient.
- </summary>
- </member>
- <member name="M:Discord.Rest.RestDMChannel.UpdateAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestDMChannel.CloseAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestDMChannel.GetUser(System.UInt64)">
- <summary>
- Gets a user in this channel from the provided <paramref name="id"/>.
- </summary>
- <param name="id">The snowflake identifier of the user.</param>
- <returns>
- A <see cref="T:Discord.Rest.RestUser"/> object that is a recipient of this channel; otherwise <c>null</c>.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestDMChannel.GetMessageAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestDMChannel.GetMessagesAsync(System.Int32,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestDMChannel.GetMessagesAsync(System.UInt64,Discord.Direction,System.Int32,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestDMChannel.GetMessagesAsync(Discord.IMessage,Discord.Direction,System.Int32,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestDMChannel.GetPinnedMessagesAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestDMChannel.SendMessageAsync(System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[])">
- <inheritdoc />
- <exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
- </member>
- <member name="M:Discord.Rest.RestDMChannel.SendFileAsync(System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[])">
- <inheritdoc />
- <exception cref="T:System.ArgumentException">
- <paramref name="filePath" /> is a zero-length string, contains only white space, or contains one or more
- invalid characters as defined by <see cref="M:System.IO.Path.GetInvalidPathChars"/>.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="filePath" /> is <c>null</c>.
- </exception>
- <exception cref="T:System.IO.PathTooLongException">
- The specified path, file name, or both exceed the system-defined maximum length. For example, on
- Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260
- characters.
- </exception>
- <exception cref="T:System.IO.DirectoryNotFoundException">
- The specified path is invalid, (for example, it is on an unmapped drive).
- </exception>
- <exception cref="T:System.UnauthorizedAccessException">
- <paramref name="filePath" /> specified a directory.-or- The caller does not have the required permission.
- </exception>
- <exception cref="T:System.IO.FileNotFoundException">
- The file specified in <paramref name="filePath" /> was not found.
- </exception>
- <exception cref="T:System.NotSupportedException"><paramref name="filePath" /> is in an invalid format.</exception>
- <exception cref="T:System.IO.IOException">An I/O error occurred while opening the file.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
- </member>
- <member name="M:Discord.Rest.RestDMChannel.SendFileAsync(System.IO.Stream,System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[])">
- <inheritdoc />
- <exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
- </member>
- <member name="M:Discord.Rest.RestDMChannel.DeleteMessageAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestDMChannel.DeleteMessageAsync(Discord.IMessage,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestDMChannel.ModifyMessageAsync(System.UInt64,System.Action{Discord.MessageProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestDMChannel.TriggerTypingAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestDMChannel.EnterTypingState(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestDMChannel.ToString">
- <summary>
- Gets a string that represents the Username#Discriminator of the recipient.
- </summary>
- <returns>
- A string that resolves to the Recipient of this channel.
- </returns>
- </member>
- <member name="P:Discord.Rest.RestDMChannel.Discord#IDMChannel#Recipient">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestDMChannel.Discord#Rest#IRestPrivateChannel#Recipients">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestDMChannel.Discord#IPrivateChannel#Recipients">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestDMChannel.Discord#IMessageChannel#GetMessageAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestDMChannel.Discord#IMessageChannel#GetMessagesAsync(System.Int32,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestDMChannel.Discord#IMessageChannel#GetMessagesAsync(System.UInt64,Discord.Direction,System.Int32,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestDMChannel.Discord#IMessageChannel#GetMessagesAsync(Discord.IMessage,Discord.Direction,System.Int32,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestDMChannel.Discord#IMessageChannel#GetPinnedMessagesAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestDMChannel.Discord#IMessageChannel#SendFileAsync(System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[])">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestDMChannel.Discord#IMessageChannel#SendFileAsync(System.IO.Stream,System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[])">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestDMChannel.Discord#IMessageChannel#SendMessageAsync(System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[])">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestDMChannel.Discord#IChannel#Name">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestDMChannel.Discord#IChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestDMChannel.Discord#IChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="T:Discord.Rest.RestGroupChannel">
- <summary>
- Represents a REST-based group-message channel.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestGroupChannel.Name">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGroupChannel.UpdateAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGroupChannel.LeaveAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGroupChannel.GetMessageAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGroupChannel.GetMessagesAsync(System.Int32,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGroupChannel.GetMessagesAsync(System.UInt64,Discord.Direction,System.Int32,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGroupChannel.GetMessagesAsync(Discord.IMessage,Discord.Direction,System.Int32,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGroupChannel.GetPinnedMessagesAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGroupChannel.DeleteMessageAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGroupChannel.DeleteMessageAsync(Discord.IMessage,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGroupChannel.ModifyMessageAsync(System.UInt64,System.Action{Discord.MessageProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGroupChannel.SendMessageAsync(System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[])">
- <inheritdoc />
- <exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
- </member>
- <member name="M:Discord.Rest.RestGroupChannel.SendFileAsync(System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[])">
- <inheritdoc />
- <exception cref="T:System.ArgumentException">
- <paramref name="filePath" /> is a zero-length string, contains only white space, or contains one or more
- invalid characters as defined by <see cref="M:System.IO.Path.GetInvalidPathChars"/>.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="filePath" /> is <c>null</c>.
- </exception>
- <exception cref="T:System.IO.PathTooLongException">
- The specified path, file name, or both exceed the system-defined maximum length. For example, on
- Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260
- characters.
- </exception>
- <exception cref="T:System.IO.DirectoryNotFoundException">
- The specified path is invalid, (for example, it is on an unmapped drive).
- </exception>
- <exception cref="T:System.UnauthorizedAccessException">
- <paramref name="filePath" /> specified a directory.-or- The caller does not have the required permission.
- </exception>
- <exception cref="T:System.IO.FileNotFoundException">
- The file specified in <paramref name="filePath" /> was not found.
- </exception>
- <exception cref="T:System.NotSupportedException"><paramref name="filePath" /> is in an invalid format.</exception>
- <exception cref="T:System.IO.IOException">An I/O error occurred while opening the file.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
- </member>
- <member name="M:Discord.Rest.RestGroupChannel.SendFileAsync(System.IO.Stream,System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[])">
- <inheritdoc />
- <exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
- </member>
- <member name="M:Discord.Rest.RestGroupChannel.TriggerTypingAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGroupChannel.EnterTypingState(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGroupChannel.Discord#IAudioChannel#ConnectAsync(System.Boolean,System.Boolean,System.Boolean)">
- <inheritdoc />
- <exception cref="T:System.NotSupportedException">Connecting to a group channel is not supported.</exception>
- </member>
- <member name="T:Discord.Rest.RestGuildChannel">
- <summary>
- Represents a private REST-based group channel.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestGuildChannel.PermissionOverwrites">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildChannel.Name">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildChannel.Position">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildChannel.GuildId">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildChannel.UpdateAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildChannel.ModifyAsync(System.Action{Discord.GuildChannelProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildChannel.DeleteAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildChannel.GetPermissionOverwrite(Discord.IUser)">
- <summary>
- Gets the permission overwrite for a specific user.
- </summary>
- <param name="user">The user to get the overwrite from.</param>
- <returns>
- An overwrite object for the targeted user; <c>null</c> if none is set.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuildChannel.GetPermissionOverwrite(Discord.IRole)">
- <summary>
- Gets the permission overwrite for a specific role.
- </summary>
- <param name="role">The role to get the overwrite from.</param>
- <returns>
- An overwrite object for the targeted role; <c>null</c> if none is set.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuildChannel.AddPermissionOverwriteAsync(Discord.IUser,Discord.OverwritePermissions,Discord.RequestOptions)">
- <summary>
- Adds or updates the permission overwrite for the given user.
- </summary>
- <param name="user">The user to add the overwrite to.</param>
- <param name="permissions">The overwrite to add to the user.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task representing the asynchronous permission operation for adding the specified permissions to the channel.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuildChannel.AddPermissionOverwriteAsync(Discord.IRole,Discord.OverwritePermissions,Discord.RequestOptions)">
- <summary>
- Adds or updates the permission overwrite for the given role.
- </summary>
- <param name="role">The role to add the overwrite to.</param>
- <param name="permissions">The overwrite to add to the role.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task representing the asynchronous permission operation for adding the specified permissions to the channel.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuildChannel.RemovePermissionOverwriteAsync(Discord.IUser,Discord.RequestOptions)">
- <summary>
- Removes the permission overwrite for the given user, if one exists.
- </summary>
- <param name="user">The user to remove the overwrite from.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task representing the asynchronous operation for removing the specified permissions from the channel.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuildChannel.RemovePermissionOverwriteAsync(Discord.IRole,Discord.RequestOptions)">
- <summary>
- Removes the permission overwrite for the given role, if one exists.
- </summary>
- <param name="role">The role to remove the overwrite from.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task representing the asynchronous operation for removing the specified permissions from the channel.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuildChannel.ToString">
- <summary>
- Gets the name of this channel.
- </summary>
- <returns>
- A string that is the name of this channel.
- </returns>
- </member>
- <member name="P:Discord.Rest.RestGuildChannel.Discord#IGuildChannel#Guild">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildChannel.Discord#IGuildChannel#GetPermissionOverwrite(Discord.IRole)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildChannel.Discord#IGuildChannel#GetPermissionOverwrite(Discord.IUser)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildChannel.Discord#IGuildChannel#AddPermissionOverwriteAsync(Discord.IRole,Discord.OverwritePermissions,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildChannel.Discord#IGuildChannel#AddPermissionOverwriteAsync(Discord.IUser,Discord.OverwritePermissions,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildChannel.Discord#IGuildChannel#RemovePermissionOverwriteAsync(Discord.IRole,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildChannel.Discord#IGuildChannel#RemovePermissionOverwriteAsync(Discord.IUser,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildChannel.Discord#IGuildChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildChannel.Discord#IGuildChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildChannel.Discord#IChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildChannel.Discord#IChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="T:Discord.Rest.RestNewsChannel">
- <summary>
- Represents a REST-based news channel in a guild that has the same properties as a <see cref="T:Discord.Rest.RestTextChannel"/>.
- </summary>
- </member>
- <member name="T:Discord.Rest.RestStageChannel">
- <summary>
- Represents a REST-based stage channel in a guild.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestStageChannel.Topic">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestStageChannel.PrivacyLevel">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestStageChannel.DiscoverableDisabled">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestStageChannel.Live">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.RestStageChannel.ModifyInstanceAsync(System.Action{Discord.StageInstanceProperties},Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.RestStageChannel.StartStageAsync(System.String,Discord.StagePrivacyLevel,Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.RestStageChannel.StopStageAsync(Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.RestStageChannel.UpdateAsync(Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.RestStageChannel.RequestToSpeakAsync(Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.RestStageChannel.BecomeSpeakerAsync(Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.RestStageChannel.StopSpeakingAsync(Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.RestStageChannel.MoveToSpeakerAsync(Discord.IGuildUser,Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.RestStageChannel.RemoveFromSpeakerAsync(Discord.IGuildUser,Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="T:Discord.Rest.RestTextChannel">
- <summary>
- Represents a REST-based channel in a guild that can send and receive messages.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestTextChannel.Topic">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestTextChannel.SlowModeInterval">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestTextChannel.CategoryId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestTextChannel.Mention">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestTextChannel.IsNsfw">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.Update(Discord.API.Channel)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.ModifyAsync(System.Action{Discord.TextChannelProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.GetUserAsync(System.UInt64,Discord.RequestOptions)">
- <summary>
- Gets a user in this channel.
- </summary>
- <param name="id">The snowflake identifier of the user.</param>
- <param name="options">The options to be used when sending the request.</param>
- <exception cref="T:System.InvalidOperationException">
- Resolving permissions requires the parent guild to be downloaded.
- </exception>
- <returns>
- A task representing the asynchronous get operation. The task result contains a guild user object that
- represents the user; <c>null</c> if none is found.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestTextChannel.GetUsersAsync(Discord.RequestOptions)">
- <summary>
- Gets a collection of users that are able to view the channel.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <exception cref="T:System.InvalidOperationException">
- Resolving permissions requires the parent guild to be downloaded.
- </exception>
- <returns>
- A paged collection containing a collection of guild users that can access this channel. Flattening the
- paginated response into a collection of users with
- <see cref="M:Discord.AsyncEnumerableExtensions.FlattenAsync``1(System.Collections.Generic.IAsyncEnumerable{System.Collections.Generic.IEnumerable{``0}})"/> is required if you wish to access the users.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestTextChannel.GetMessageAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.GetMessagesAsync(System.Int32,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.GetMessagesAsync(System.UInt64,Discord.Direction,System.Int32,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.GetMessagesAsync(Discord.IMessage,Discord.Direction,System.Int32,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.GetPinnedMessagesAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.SendMessageAsync(System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[])">
- <inheritdoc />
- <exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
- </member>
- <member name="M:Discord.Rest.RestTextChannel.SendFileAsync(System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[])">
- <inheritdoc />
- <exception cref="T:System.ArgumentException">
- <paramref name="filePath" /> is a zero-length string, contains only white space, or contains one or more
- invalid characters as defined by <see cref="M:System.IO.Path.GetInvalidPathChars"/>.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="filePath" /> is <c>null</c>.
- </exception>
- <exception cref="T:System.IO.PathTooLongException">
- The specified path, file name, or both exceed the system-defined maximum length. For example, on
- Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260
- characters.
- </exception>
- <exception cref="T:System.IO.DirectoryNotFoundException">
- The specified path is invalid, (for example, it is on an unmapped drive).
- </exception>
- <exception cref="T:System.UnauthorizedAccessException">
- <paramref name="filePath" /> specified a directory.-or- The caller does not have the required permission.
- </exception>
- <exception cref="T:System.IO.FileNotFoundException">
- The file specified in <paramref name="filePath" /> was not found.
- </exception>
- <exception cref="T:System.NotSupportedException"><paramref name="filePath" /> is in an invalid format.</exception>
- <exception cref="T:System.IO.IOException">An I/O error occurred while opening the file.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
- </member>
- <member name="M:Discord.Rest.RestTextChannel.SendFileAsync(System.IO.Stream,System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[])">
- <inheritdoc />
- <exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
- </member>
- <member name="M:Discord.Rest.RestTextChannel.DeleteMessageAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.DeleteMessageAsync(Discord.IMessage,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.DeleteMessagesAsync(System.Collections.Generic.IEnumerable{Discord.IMessage},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.DeleteMessagesAsync(System.Collections.Generic.IEnumerable{System.UInt64},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.ModifyMessageAsync(System.UInt64,System.Action{Discord.MessageProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.TriggerTypingAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.EnterTypingState(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.CreateWebhookAsync(System.String,System.IO.Stream,Discord.RequestOptions)">
- <summary>
- Creates a webhook in this text channel.
- </summary>
- <param name="name">The name of the webhook.</param>
- <param name="avatar">The avatar of the webhook.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous creation operation. The task result contains the newly created
- webhook.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestTextChannel.GetWebhookAsync(System.UInt64,Discord.RequestOptions)">
- <summary>
- Gets a webhook available in this text channel.
- </summary>
- <param name="id">The identifier of the webhook.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a webhook associated
- with the identifier; <c>null</c> if the webhook is not found.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestTextChannel.GetWebhooksAsync(Discord.RequestOptions)">
- <summary>
- Gets the webhooks available in this text channel.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a read-only collection
- of webhooks that is available in this channel.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestTextChannel.GetCategoryAsync(Discord.RequestOptions)">
- <summary>
- Gets the parent (category) channel of this channel.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains the category channel
- representing the parent of this channel; <c>null</c> if none is set.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestTextChannel.SyncPermissionsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.CreateInviteAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.GetInvitesAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.CreateThreadAsync(System.String,Discord.ThreadType,Discord.ThreadArchiveDuration,Discord.IMessage,Discord.RequestOptions)">
- <summary>
- Creates a thread within this <see cref="T:Discord.ITextChannel"/>.
- </summary>
- <remarks>
- When <paramref name="message"/> is <see langword="null"/> the thread type will be based off of the
- channel its created in. When called on a <see cref="T:Discord.ITextChannel"/>, it creates a <see cref="F:Discord.ThreadType.PublicThread"/>.
- When called on a <see cref="T:Discord.INewsChannel"/>, it creates a <see cref="F:Discord.ThreadType.NewsThread"/>. The id of the created
- thread will be the same as the id of the message, and as such a message can only have a
- single thread created from it.
- </remarks>
- <param name="name">The name of the thread.</param>
- <param name="type">
- The type of the thread.
- <para>
- <b>Note: </b>This parameter is not used if the <paramref name="message"/> parameter is not specified.
- </para>
- </param>
- <param name="autoArchiveDuration">
- The duration on which this thread archives after.
- <para>
- <b>Note: </b> Options <see cref="F:Discord.ThreadArchiveDuration.OneWeek"/> and <see cref="F:Discord.ThreadArchiveDuration.ThreeDays"/>
- are only available for guilds that are boosted. You can check in the <see cref="P:Discord.IGuild.Features"/> to see if the
- guild has the <b>THREE_DAY_THREAD_ARCHIVE</b> and <b>SEVEN_DAY_THREAD_ARCHIVE</b>.
- </para>
- </param>
- <param name="message">The message which to start the thread from.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous create operation. The task result contains a <see cref="T:Discord.IThreadChannel"/>
- </returns>
- </member>
- <member name="M:Discord.Rest.RestTextChannel.Discord#ITextChannel#CreateWebhookAsync(System.String,System.IO.Stream,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.Discord#ITextChannel#GetWebhookAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.Discord#ITextChannel#GetWebhooksAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.Discord#IMessageChannel#GetMessageAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.Discord#IMessageChannel#GetMessagesAsync(System.Int32,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.Discord#IMessageChannel#GetMessagesAsync(System.UInt64,Discord.Direction,System.Int32,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.Discord#IMessageChannel#GetMessagesAsync(Discord.IMessage,Discord.Direction,System.Int32,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.Discord#IMessageChannel#GetPinnedMessagesAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.Discord#IMessageChannel#SendFileAsync(System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[])">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.Discord#IMessageChannel#SendFileAsync(System.IO.Stream,System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[])">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.Discord#IMessageChannel#SendMessageAsync(System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[])">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.Discord#IGuildChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.Discord#IGuildChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.Discord#IChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.Discord#IChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestTextChannel.Discord#INestedChannel#GetCategoryAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="T:Discord.Rest.RestThreadChannel">
- <summary>
- Represents a thread channel recieved over REST.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestThreadChannel.Joined">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestThreadChannel.Archived">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestThreadChannel.AutoArchiveDuration">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestThreadChannel.ArchiveTimestamp">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestThreadChannel.Locked">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestThreadChannel.MemberCount">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestThreadChannel.MessageCount">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestThreadChannel.ParentChannelId">
- <summary>
- Gets the parent text channel id.
- </summary>
- </member>
- <member name="M:Discord.Rest.RestThreadChannel.GetUserAsync(System.UInt64,Discord.RequestOptions)">
- <summary>
- Gets a user within this thread.
- </summary>
- <param name="userId">The id of the user to fetch.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task representing the asyncronous get operation. The task returns a
- <see cref="T:Discord.Rest.RestThreadUser"/> if found, otherwise <see langword="null"/>.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestThreadChannel.GetUsersAsync(Discord.RequestOptions)">
- <summary>
- Gets a collection of users within this thread.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task representing the asyncronous get operation. The task returns a
- <see cref="T:System.Collections.Generic.IReadOnlyCollection`1"/> of <see cref="T:Discord.Rest.RestThreadUser"/>'s.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestThreadChannel.ModifyAsync(System.Action{Discord.TextChannelProperties},Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.RestThreadChannel.AddPermissionOverwriteAsync(Discord.IRole,Discord.OverwritePermissions,Discord.RequestOptions)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.Rest.RestThreadChannel.AddPermissionOverwriteAsync(Discord.IUser,Discord.OverwritePermissions,Discord.RequestOptions)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.Rest.RestThreadChannel.CreateInviteAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.Rest.RestThreadChannel.CreateInviteToApplicationAsync(System.UInt64,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.Rest.RestThreadChannel.CreateInviteToStreamAsync(Discord.IUser,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.Rest.RestThreadChannel.CreateWebhookAsync(System.String,System.IO.Stream,Discord.RequestOptions)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.Rest.RestThreadChannel.GetCategoryAsync(Discord.RequestOptions)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.Rest.RestThreadChannel.GetInvitesAsync(Discord.RequestOptions)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.Rest.RestThreadChannel.GetPermissionOverwrite(Discord.IRole)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.Rest.RestThreadChannel.GetPermissionOverwrite(Discord.IUser)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.Rest.RestThreadChannel.GetWebhookAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.Rest.RestThreadChannel.GetWebhooksAsync(Discord.RequestOptions)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.Rest.RestThreadChannel.RemovePermissionOverwriteAsync(Discord.IRole,Discord.RequestOptions)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.Rest.RestThreadChannel.RemovePermissionOverwriteAsync(Discord.IUser,Discord.RequestOptions)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="P:Discord.Rest.RestThreadChannel.PermissionOverwrites">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.Rest.RestThreadChannel.JoinAsync(Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.RestThreadChannel.LeaveAsync(Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.RestThreadChannel.AddUserAsync(Discord.IGuildUser,Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.RestThreadChannel.RemoveUserAsync(Discord.IGuildUser,Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="T:Discord.Rest.RestVoiceChannel">
- <summary>
- Represents a REST-based voice channel in a guild.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestVoiceChannel.Bitrate">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestVoiceChannel.UserLimit">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestVoiceChannel.CategoryId">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestVoiceChannel.Update(Discord.API.Channel)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestVoiceChannel.ModifyAsync(System.Action{Discord.VoiceChannelProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestVoiceChannel.GetCategoryAsync(Discord.RequestOptions)">
- <summary>
- Gets the parent (category) channel of this channel.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains the category channel
- representing the parent of this channel; <c>null</c> if none is set.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestVoiceChannel.SyncPermissionsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestVoiceChannel.CreateInviteAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestVoiceChannel.CreateInviteToApplicationAsync(System.UInt64,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestVoiceChannel.CreateInviteToStreamAsync(Discord.IUser,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestVoiceChannel.GetInvitesAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestVoiceChannel.Discord#IAudioChannel#ConnectAsync(System.Boolean,System.Boolean,System.Boolean)">
- <inheritdoc />
- <exception cref="T:System.NotSupportedException">Connecting to a REST-based channel is not supported.</exception>
- </member>
- <member name="M:Discord.Rest.RestVoiceChannel.Discord#IGuildChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestVoiceChannel.Discord#IGuildChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestVoiceChannel.Discord#INestedChannel#GetCategoryAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.GuildHelper.ModifyAsync(Discord.IGuild,Discord.Rest.BaseDiscordClient,System.Action{Discord.GuildProperties},Discord.RequestOptions)">
- <exception cref="T:System.ArgumentNullException"><paramref name="func"/> is <c>null</c>.</exception>
- </member>
- <member name="M:Discord.Rest.GuildHelper.ModifyWidgetAsync(Discord.IGuild,Discord.Rest.BaseDiscordClient,System.Action{Discord.GuildWidgetProperties},Discord.RequestOptions)">
- <exception cref="T:System.ArgumentNullException"><paramref name="func"/> is <c>null</c>.</exception>
- </member>
- <member name="M:Discord.Rest.GuildHelper.CreateTextChannelAsync(Discord.IGuild,Discord.Rest.BaseDiscordClient,System.String,Discord.RequestOptions,System.Action{Discord.TextChannelProperties})">
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <c>null</c>.</exception>
- </member>
- <member name="M:Discord.Rest.GuildHelper.CreateVoiceChannelAsync(Discord.IGuild,Discord.Rest.BaseDiscordClient,System.String,Discord.RequestOptions,System.Action{Discord.VoiceChannelProperties})">
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <c>null</c>.</exception>
- </member>
- <member name="M:Discord.Rest.GuildHelper.CreateCategoryChannelAsync(Discord.IGuild,Discord.Rest.BaseDiscordClient,System.String,Discord.RequestOptions,System.Action{Discord.GuildChannelProperties})">
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <c>null</c>.</exception>
- </member>
- <member name="M:Discord.Rest.GuildHelper.CreateRoleAsync(Discord.IGuild,Discord.Rest.BaseDiscordClient,System.String,System.Nullable{Discord.GuildPermissions},System.Nullable{Discord.Color},System.Boolean,System.Boolean,Discord.RequestOptions)">
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <c>null</c>.</exception>
- </member>
- <member name="M:Discord.Rest.GuildHelper.ModifyEmoteAsync(Discord.IGuild,Discord.Rest.BaseDiscordClient,System.UInt64,System.Action{Discord.EmoteProperties},Discord.RequestOptions)">
- <exception cref="T:System.ArgumentNullException"><paramref name="func"/> is <c>null</c>.</exception>
- </member>
- <member name="T:Discord.Rest.RestBan">
- <summary>
- Represents a REST-based ban object.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestBan.User">
- <summary>
- Gets the banned user.
- </summary>
- <returns>
- A generic <see cref="T:Discord.Rest.RestUser"/> object that was banned.
- </returns>
- </member>
- <member name="P:Discord.Rest.RestBan.Reason">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestBan.ToString">
- <summary>
- Gets the name of the banned user.
- </summary>
- <returns>
- A string containing the name of the user that was banned.
- </returns>
- </member>
- <member name="P:Discord.Rest.RestBan.Discord#IBan#User">
- <inheritdoc />
- </member>
- <member name="T:Discord.Rest.RestGuild">
- <summary>
- Represents a REST-based guild/server.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestGuild.Name">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.AFKTimeout">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.IsWidgetEnabled">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.VerificationLevel">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.MfaLevel">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.DefaultMessageNotifications">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.ExplicitContentFilter">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.AFKChannelId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.WidgetChannelId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.SystemChannelId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.RulesChannelId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.PublicUpdatesChannelId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.OwnerId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.VoiceRegionId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.IconId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.SplashId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.DiscoverySplashId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.ApplicationId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.PremiumTier">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.BannerId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.VanityURLCode">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.SystemChannelFlags">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.Description">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.PremiumSubscriptionCount">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.PreferredLocale">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.MaxPresences">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.MaxMembers">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.MaxVideoChannelUsers">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.ApproximateMemberCount">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.ApproximatePresenceCount">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.NsfwLevel">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.PreferredCulture">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.CreatedAt">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.IconUrl">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.SplashUrl">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.DiscoverySplashUrl">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.BannerUrl">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.EveryoneRole">
- <summary>
- Gets the built-in role containing all users in this guild.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestGuild.Roles">
- <summary>
- Gets a collection of all roles in this guild.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestGuild.Emotes">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.Features">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.UpdateAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.UpdateAsync(System.Boolean,Discord.RequestOptions)">
- <summary>
- Updates this object's properties with its current state.
- </summary>
- <param name="withCounts">
- If true, <see cref="P:Discord.Rest.RestGuild.ApproximateMemberCount"/> and <see cref="P:Discord.Rest.RestGuild.ApproximatePresenceCount"/>
- will be updated as well.
- </param>
- <param name="options">The options to be used when sending the request.</param>
- <remarks>
- If <paramref name="withCounts"/> is true, <see cref="P:Discord.Rest.RestGuild.ApproximateMemberCount"/> and
- <see cref="P:Discord.Rest.RestGuild.ApproximatePresenceCount"/> will be updated as well.
- </remarks>
- </member>
- <member name="M:Discord.Rest.RestGuild.DeleteAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.ModifyAsync(System.Action{Discord.GuildProperties},Discord.RequestOptions)">
- <inheritdoc />
- <exception cref="T:System.ArgumentNullException"><paramref name="func"/> is <see langword="null"/>.</exception>
- </member>
- <member name="M:Discord.Rest.RestGuild.ModifyWidgetAsync(System.Action{Discord.GuildWidgetProperties},Discord.RequestOptions)">
- <inheritdoc />
- <exception cref="T:System.ArgumentNullException"><paramref name="func"/> is <see langword="null"/>.</exception>
- </member>
- <member name="M:Discord.Rest.RestGuild.ReorderChannelsAsync(System.Collections.Generic.IEnumerable{Discord.ReorderChannelProperties},Discord.RequestOptions)">
- <inheritdoc />
- <exception cref="T:System.ArgumentNullException"><paramref name="args" /> is <see langword="null"/>.</exception>
- </member>
- <member name="M:Discord.Rest.RestGuild.ReorderRolesAsync(System.Collections.Generic.IEnumerable{Discord.ReorderRoleProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.LeaveAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.DeleteSlashCommandsAsync(Discord.RequestOptions)">
- <summary>
- Deletes all slash commands in the current guild.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous delete operation.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetSlashCommandsAsync(Discord.RequestOptions)">
- <summary>
- Gets a collection of slash commands created by the current user in this guild.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a read-only collection of
- slash commands created by the current user.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetSlashCommandAsync(System.UInt64,Discord.RequestOptions)">
- <summary>
- Gets a slash command in the current guild.
- </summary>
- <param name="id">The unique identifier of the slash command.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a
- slash command created by the current user.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetBansAsync(Discord.RequestOptions)">
- <summary>
- Gets a collection of all users banned in this guild.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a read-only collection of
- ban objects that this guild currently possesses, with each object containing the user banned and reason
- behind the ban.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetBanAsync(Discord.IUser,Discord.RequestOptions)">
- <summary>
- Gets a ban object for a banned user.
- </summary>
- <param name="user">The banned user.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a ban object, which
- contains the user information and the reason for the ban; <see langword="null"/> if the ban entry cannot be found.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetBanAsync(System.UInt64,Discord.RequestOptions)">
- <summary>
- Gets a ban object for a banned user.
- </summary>
- <param name="userId">The snowflake identifier for the banned user.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a ban object, which
- contains the user information and the reason for the ban; <see langword="null"/> if the ban entry cannot be found.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.AddBanAsync(Discord.IUser,System.Int32,System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.AddBanAsync(System.UInt64,System.Int32,System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.RemoveBanAsync(Discord.IUser,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.RemoveBanAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.GetChannelsAsync(Discord.RequestOptions)">
- <summary>
- Gets a collection of all channels in this guild.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a read-only collection of
- generic channels found within this guild.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetChannelAsync(System.UInt64,Discord.RequestOptions)">
- <summary>
- Gets a channel in this guild.
- </summary>
- <param name="id">The snowflake identifier for the channel.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains the generic channel
- associated with the specified <paramref name="id"/>; <see langword="null"/> if none is found.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetTextChannelAsync(System.UInt64,Discord.RequestOptions)">
- <summary>
- Gets a text channel in this guild.
- </summary>
- <param name="id">The snowflake identifier for the text channel.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains the text channel
- associated with the specified <paramref name="id"/>; <see langword="null"/> if none is found.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetTextChannelsAsync(Discord.RequestOptions)">
- <summary>
- Gets a collection of all text channels in this guild.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a read-only collection of
- message channels found within this guild.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetThreadChannelAsync(System.UInt64,Discord.RequestOptions)">
- <summary>
- Gets a thread channel in this guild.
- </summary>
- <param name="id">The snowflake identifier for the thread channel.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains the thread channel associated
- with the specified <paramref name="id"/>; <see langword="null"/> if none is found.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetThreadChannelsAsync(Discord.RequestOptions)">
- <summary>
- Gets a collection of all thread in this guild.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a read-only collection of
- threads found within this guild.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetVoiceChannelAsync(System.UInt64,Discord.RequestOptions)">
- <summary>
- Gets a voice channel in this guild.
- </summary>
- <param name="id">The snowflake identifier for the voice channel.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains the voice channel associated
- with the specified <paramref name="id"/>; <see langword="null"/> if none is found.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetVoiceChannelsAsync(Discord.RequestOptions)">
- <summary>
- Gets a collection of all voice channels in this guild.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a read-only collection of
- voice channels found within this guild.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetStageChannelAsync(System.UInt64,Discord.RequestOptions)">
- <summary>
- Gets a stage channel in this guild
- </summary>
- <param name="id">The snowflake identifier for the stage channel.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains the stage channel associated
- with the specified <paramref name="id"/>; <see langword="null" /> if none is found.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetStageChannelsAsync(Discord.RequestOptions)">
- <summary>
- Gets a collection of all stage channels in this guild.
- </summary>
- <param name="mode">The <see cref="T:Discord.CacheMode"/> that determines whether the object should be fetched from cache.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a read-only collection of
- stage channels found within this guild.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetCategoryChannelsAsync(Discord.RequestOptions)">
- <summary>
- Gets a collection of all category channels in this guild.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a read-only collection of
- category channels found within this guild.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetAFKChannelAsync(Discord.RequestOptions)">
- <summary>
- Gets the AFK voice channel in this guild.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains the voice channel that the
- AFK users will be moved to after they have idled for too long; <see langword="null"/> if none is set.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetDefaultChannelAsync(Discord.RequestOptions)">
- <summary>
- Gets the first viewable text channel in this guild.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains the first viewable text
- channel in this guild; <see langword="null"/> if none is found.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetWidgetChannelAsync(Discord.RequestOptions)">
- <summary>
- Gets the widget channel (i.e. the channel set in the guild's widget settings) in this guild.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains the widget channel set
- within the server's widget settings; <see langword="null"/> if none is set.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetSystemChannelAsync(Discord.RequestOptions)">
- <summary>
- Gets the text channel where guild notices such as welcome messages and boost events are posted.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains the text channel
- where guild notices such as welcome messages and boost events are poste; <see langword="null"/> if none is found.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetRulesChannelAsync(Discord.RequestOptions)">
- <summary>
- Gets the text channel where Community guilds can display rules and/or guidelines.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains the text channel
- where Community guilds can display rules and/or guidelines; <see langword="null"/> if none is set.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetPublicUpdatesChannelAsync(Discord.RequestOptions)">
- <summary>
- Gets the text channel channel where admins and moderators of Community guilds receive notices from Discord.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains the text channel channel where
- admins and moderators of Community guilds receive notices from Discord; <see langword="null"/> if none is set.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.CreateTextChannelAsync(System.String,System.Action{Discord.TextChannelProperties},Discord.RequestOptions)">
- <summary>
- Creates a new text channel in this guild.
- </summary>
- <example>
- The following example creates a new text channel under an existing category named <c>Wumpus</c> with a set topic.
- <code language="cs">
- var categories = await guild.GetCategoriesAsync();
- var targetCategory = categories.FirstOrDefault(x => x.Name == "wumpus");
- if (targetCategory == null) return;
- await Context.Guild.CreateTextChannelAsync(name, x =>
- {
- x.CategoryId = targetCategory.Id;
- x.Topic = $"This channel was created at {DateTimeOffset.UtcNow} by {user}.";
- });
- </code>
- </example>
- <param name="name">The new name for the text channel.</param>
- <param name="func">The delegate containing the properties to be applied to the channel upon its creation.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous creation operation. The task result contains the newly created
- text channel.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.CreateVoiceChannelAsync(System.String,System.Action{Discord.VoiceChannelProperties},Discord.RequestOptions)">
- <summary>
- Creates a voice channel with the provided name.
- </summary>
- <param name="name">The name of the new channel.</param>
- <param name="func">The delegate containing the properties to be applied to the channel upon its creation.</param>
- <param name="options">The options to be used when sending the request.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="name" /> is <see langword="null"/>.</exception>
- <returns>
- The created voice channel.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.CreateStageChannelAsync(System.String,System.Action{Discord.VoiceChannelProperties},Discord.RequestOptions)">
- <summary>
- Creates a new stage channel in this guild.
- </summary>
- <param name="name">The new name for the stage channel.</param>
- <param name="func">The delegate containing the properties to be applied to the channel upon its creation.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous creation operation. The task result contains the newly created
- stage channel.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.CreateCategoryChannelAsync(System.String,System.Action{Discord.GuildChannelProperties},Discord.RequestOptions)">
- <summary>
- Creates a category channel with the provided name.
- </summary>
- <param name="name">The name of the new channel.</param>
- <param name="func">The delegate containing the properties to be applied to the channel upon its creation.</param>
- <param name="options">The options to be used when sending the request.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="name" /> is <see langword="null"/>.</exception>
- <returns>
- The created category channel.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetVoiceRegionsAsync(Discord.RequestOptions)">
- <summary>
- Gets a collection of all the voice regions this guild can access.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a read-only collection of
- voice regions the guild can access.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetInvitesAsync(Discord.RequestOptions)">
- <summary>
- Gets a collection of all invites in this guild.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a read-only collection of
- invite metadata, each representing information for an invite found within this guild.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetVanityInviteAsync(Discord.RequestOptions)">
- <summary>
- Gets the vanity invite URL of this guild.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A partial metadata of the vanity invite found within this guild.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetRole(System.UInt64)">
- <summary>
- Gets a role in this guild.
- </summary>
- <param name="id">The snowflake identifier for the role.</param>
- <returns>
- A role that is associated with the specified <paramref name="id"/>; <see langword="null"/> if none is found.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.CreateRoleAsync(System.String,System.Nullable{Discord.GuildPermissions},System.Nullable{Discord.Color},System.Boolean,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.CreateRoleAsync(System.String,System.Nullable{Discord.GuildPermissions},System.Nullable{Discord.Color},System.Boolean,System.Boolean,Discord.RequestOptions)">
- <summary>
- Creates a new role with the provided name.
- </summary>
- <param name="name">The new name for the role.</param>
- <param name="permissions">The guild permission that the role should possess.</param>
- <param name="color">The color of the role.</param>
- <param name="isHoisted">Whether the role is separated from others on the sidebar.</param>
- <param name="options">The options to be used when sending the request.</param>
- <param name="isMentionable">Whether the role can be mentioned.</param>
- <returns>
- A task that represents the asynchronous creation operation. The task result contains the newly created
- role.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetUsersAsync(Discord.RequestOptions)">
- <summary>
- Gets a collection of all users in this guild.
- </summary>
- <remarks>
- This method retrieves all users found within this guild.
- </remarks>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a collection of guild
- users found within this guild.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.AddGuildUserAsync(System.UInt64,System.String,System.Action{Discord.AddGuildUserProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.GetUserAsync(System.UInt64,Discord.RequestOptions)">
- <summary>
- Gets a user from this guild.
- </summary>
- <remarks>
- This method retrieves a user found within this guild.
- </remarks>
- <param name="id">The snowflake identifier of the user.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains the guild user
- associated with the specified <paramref name="id"/>; <see langword="null"/> if none is found.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetCurrentUserAsync(Discord.RequestOptions)">
- <summary>
- Gets the current user for this guild.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains the currently logged-in
- user within this guild.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetOwnerAsync(Discord.RequestOptions)">
- <summary>
- Gets the owner of this guild.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains the owner of this guild.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.PruneUsersAsync(System.Int32,System.Boolean,Discord.RequestOptions,System.Collections.Generic.IEnumerable{System.UInt64})">
- <inheritdoc />
- <summary>
- Prunes inactive users.
- </summary>
- <remarks>
- <para>
- This method removes all users that have not logged on in the provided number of <paramref name="days"/>.
- </para>
- <para>
- If <paramref name="simulate" /> is <c>true</c>, this method will only return the number of users that
- would be removed without kicking the users.
- </para>
- </remarks>
- <param name="days">The number of days required for the users to be kicked.</param>
- <param name="simulate">Whether this prune action is a simulation.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous prune operation. The task result contains the number of users to
- be or has been removed from this guild.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.SearchUsersAsync(System.String,System.Int32,Discord.RequestOptions)">
- <summary>
- Gets a collection of users in this guild that the name or nickname starts with the
- provided <see cref="T:System.String"/> at <paramref name="query"/>.
- </summary>
- <remarks>
- The <paramref name="limit"/> can not be higher than <see cref="F:Discord.DiscordConfig.MaxUsersPerBatch"/>.
- </remarks>
- <param name="query">The partial name or nickname to search.</param>
- <param name="limit">The maximum number of users to be gotten.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a collection of guild
- users that the name or nickname starts with the provided <see cref="T:System.String"/> at <paramref name="query"/>.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetAuditLogsAsync(System.Int32,Discord.RequestOptions,System.Nullable{System.UInt64},System.Nullable{System.UInt64},System.Nullable{Discord.ActionType})">
- <summary>
- Gets the specified number of audit log entries for this guild.
- </summary>
- <param name="limit">The number of audit log entries to fetch.</param>
- <param name="options">The options to be used when sending the request.</param>
- <param name="beforeId">The audit log entry ID to get entries before.</param>
- <param name="actionType">The type of actions to filter.</param>
- <param name="userId">The user ID to filter entries for.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a read-only collection
- of the requested audit log entries.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetWebhookAsync(System.UInt64,Discord.RequestOptions)">
- <summary>
- Gets a webhook found within this guild.
- </summary>
- <param name="id">The identifier for the webhook.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains the webhook with the
- specified <paramref name="id"/>; <see langword="null"/> if none is found.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetWebhooksAsync(Discord.RequestOptions)">
- <summary>
- Gets a collection of all webhook from this guild.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a read-only collection
- of webhooks found within the guild.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetApplicationCommandsAsync(Discord.RequestOptions)">
- <summary>
- Gets this guilds slash commands commands
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a read-only collection
- of application commands found within the guild.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetApplicationCommandAsync(System.UInt64,Discord.RequestOptions)">
- <summary>
- Gets an application command within this guild with the specified id.
- </summary>
- <param name="id">The id of the application command to get.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A ValueTask that represents the asynchronous get operation. The task result contains a <see cref="T:Discord.IApplicationCommand"/>
- if found, otherwise <see langword="null"/>.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.CreateApplicationCommandAsync(Discord.ApplicationCommandProperties,Discord.RequestOptions)">
- <summary>
- Creates an application command within this guild.
- </summary>
- <param name="properties">The properties to use when creating the command.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous creation operation. The task result contains the command that was created.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.BulkOverwriteApplicationCommandsAsync(Discord.ApplicationCommandProperties[],Discord.RequestOptions)">
- <summary>
- Overwrites the application commands within this guild.
- </summary>
- <param name="properties">A collection of properties to use when creating the commands.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous creation operation. The task result contains a collection of commands that was created.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.ToString">
- <summary>
- Returns the name of the guild.
- </summary>
- <returns>
- The name of the guild.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetEmotesAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.GetEmoteAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.CreateEmoteAsync(System.String,Discord.Image,Discord.Optional{System.Collections.Generic.IEnumerable{Discord.IRole}},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.ModifyEmoteAsync(Discord.GuildEmote,System.Action{Discord.EmoteProperties},Discord.RequestOptions)">
- <inheritdoc />
- <exception cref="T:System.ArgumentNullException"><paramref name="func"/> is <see langword="null"/>.</exception>
- </member>
- <member name="M:Discord.Rest.RestGuild.MoveAsync(Discord.IGuildUser,Discord.IVoiceChannel)">
- <summary>
- Moves the user to the voice channel.
- </summary>
- <param name="user">The user to move.</param>
- <param name="targetChannel">the channel where the user gets moved to.</param>
- <returns>A task that represents the asynchronous operation for moving a user.</returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.DeleteEmoteAsync(Discord.GuildEmote,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.CreateStickerAsync(System.String,System.String,System.Collections.Generic.IEnumerable{System.String},Discord.Image,Discord.RequestOptions)">
- <summary>
- Creates a new sticker in this guild.
- </summary>
- <param name="name">The name of the sticker.</param>
- <param name="description">The description of the sticker.</param>
- <param name="tags">The tags of the sticker.</param>
- <param name="image">The image of the new emote.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous creation operation. The task result contains the created sticker.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.CreateStickerAsync(System.String,System.String,System.Collections.Generic.IEnumerable{System.String},System.String,Discord.RequestOptions)">
- <summary>
- Creates a new sticker in this guild
- </summary>
- <param name="name">The name of the sticker.</param>
- <param name="description">The description of the sticker.</param>
- <param name="tags">The tags of the sticker.</param>
- <param name="path">The path of the file to upload.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous creation operation. The task result contains the created sticker.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.CreateStickerAsync(System.String,System.String,System.Collections.Generic.IEnumerable{System.String},System.IO.Stream,System.String,Discord.RequestOptions)">
- <summary>
- Creates a new sticker in this guild
- </summary>
- <param name="name">The name of the sticker.</param>
- <param name="description">The description of the sticker.</param>
- <param name="tags">The tags of the sticker.</param>
- <param name="stream">The stream containing the file data.</param>
- <param name="filename">The name of the file <b>with</b> the extension, ex: image.png</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous creation operation. The task result contains the created sticker.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetStickerAsync(System.UInt64,Discord.RequestOptions)">
- <summary>
- Gets a specific sticker within this guild.
- </summary>
- <param name="id">The id of the sticker to get.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains the sticker found with the
- specified <paramref name="id"/>; <see langword="null" /> if none is found.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.GetStickersAsync(Discord.RequestOptions)">
- <summary>
- Gets a collection of all stickers within this guild.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a read-only collection
- of stickers found within the guild.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.DeleteStickerAsync(Discord.Rest.CustomSticker,Discord.RequestOptions)">
- <summary>
- Deletes a sticker within this guild.
- </summary>
- <param name="sticker">The sticker to delete.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous removal operation.
- </returns>
- </member>
- <member name="P:Discord.Rest.RestGuild.Discord#IGuild#Available">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.Discord#IGuild#AudioClient">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.Discord#IGuild#EveryoneRole">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuild.Discord#IGuild#Roles">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetBansAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetBanAsync(Discord.IUser,Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetBanAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetTextChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetTextChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetThreadChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetThreadChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetVoiceChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetCategoriesAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetStageChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetStageChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetVoiceChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetAFKChannelAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetDefaultChannelAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetWidgetChannelAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetSystemChannelAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetRulesChannelAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetPublicUpdatesChannelAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#CreateTextChannelAsync(System.String,System.Action{Discord.TextChannelProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#CreateVoiceChannelAsync(System.String,System.Action{Discord.VoiceChannelProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#CreateStageChannelAsync(System.String,System.Action{Discord.VoiceChannelProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#CreateCategoryAsync(System.String,System.Action{Discord.GuildChannelProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetVoiceRegionsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetIntegrationsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#CreateIntegrationAsync(System.UInt64,System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetInvitesAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetVanityInviteAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetRole(System.UInt64)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#CreateRoleAsync(System.String,System.Nullable{Discord.GuildPermissions},System.Nullable{Discord.Color},System.Boolean,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#CreateRoleAsync(System.String,System.Nullable{Discord.GuildPermissions},System.Nullable{Discord.Color},System.Boolean,System.Boolean,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#AddGuildUserAsync(System.UInt64,System.String,System.Action{Discord.AddGuildUserProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#DisconnectAsync(Discord.IGuildUser)">
- <summary>
- Disconnects the user from its current voice channel
- </summary>
- <param name="user">The user to disconnect.</param>
- <returns>A task that represents the asynchronous operation for disconnecting a user.</returns>
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetCurrentUserAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetOwnerAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#DownloadUsersAsync">
- <inheritdoc />
- <exception cref="T:System.NotSupportedException">Downloading users is not supported for a REST-based guild.</exception>
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#SearchUsersAsync(System.String,System.Int32,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetWebhookAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetWebhooksAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetApplicationCommandsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#CreateStickerAsync(System.String,System.String,System.Collections.Generic.IEnumerable{System.String},Discord.Image,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#CreateStickerAsync(System.String,System.String,System.Collections.Generic.IEnumerable{System.String},System.IO.Stream,System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#CreateStickerAsync(System.String,System.String,System.Collections.Generic.IEnumerable{System.String},System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetStickerAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetStickersAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#DeleteStickerAsync(Discord.ICustomSticker,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#CreateApplicationCommandAsync(Discord.ApplicationCommandProperties,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#BulkOverwriteApplicationCommandsAsync(Discord.ApplicationCommandProperties[],Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuild.Discord#IGuild#GetApplicationCommandAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildIntegration.Name">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildIntegration.Type">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildIntegration.IsEnabled">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildIntegration.IsSyncing">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildIntegration.ExpireBehavior">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildIntegration.ExpireGracePeriod">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildIntegration.GuildId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildIntegration.RoleId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildIntegration.Account">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildIntegration.SyncedAt">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildIntegration.Discord#IGuildIntegration#Guild">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildIntegration.Discord#IGuildIntegration#User">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUserGuild.Name">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUserGuild.IsOwner">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUserGuild.Permissions">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUserGuild.CreatedAt">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUserGuild.IconUrl">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestUserGuild.DeleteAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="T:Discord.Rest.RestVoiceRegion">
- <summary>
- Represents a REST-based voice region.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestVoiceRegion.Name">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestVoiceRegion.IsVip">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestVoiceRegion.IsOptimal">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestVoiceRegion.IsDeprecated">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestVoiceRegion.IsCustom">
- <inheritdoc />
- </member>
- <member name="T:Discord.Rest.RestApplicationCommand">
- <summary>
- Represents a Rest-based implementation of the <see cref="T:Discord.IApplicationCommand"/>.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestApplicationCommand.ApplicationId">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestApplicationCommand.Type">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestApplicationCommand.Name">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestApplicationCommand.Description">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestApplicationCommand.DefaultPermission">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestApplicationCommand.Options">
- <summary>
- The options of this command.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestApplicationCommand.CreatedAt">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.RestApplicationCommand.DeleteAsync(Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.RestApplicationCommand.ModifyAsync(System.Action{Discord.ApplicationCommandProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestApplicationCommand.ModifyAsync``1(System.Action{``0},Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="T:Discord.Rest.RestApplicationCommandChoice">
- <summary>
- Represents a Rest-based implementation of <see cref="T:Discord.IApplicationCommandOptionChoice"/>.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestApplicationCommandChoice.Name">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestApplicationCommandChoice.Value">
- <inheritdoc/>
- </member>
- <member name="T:Discord.Rest.RestApplicationCommandOption">
- <summary>
- Represents a Rest-based implementation of <see cref="T:Discord.IApplicationCommandOption"/>.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestApplicationCommandOption.Type">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestApplicationCommandOption.Name">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestApplicationCommandOption.Description">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestApplicationCommandOption.Default">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestApplicationCommandOption.Required">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestApplicationCommandOption.Choices">
- <summary>
- A collection of <see cref="T:Discord.Rest.RestApplicationCommandChoice"/>'s for this command.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestApplicationCommandOption.Options">
- <summary>
- A collection of <see cref="T:Discord.Rest.RestApplicationCommandOption"/>'s for this command.
- </summary>
- </member>
- <member name="T:Discord.Rest.RestGlobalCommand">
- <summary>
- Represents a Rest-based global application command.
- </summary>
- </member>
- <member name="M:Discord.Rest.RestGlobalCommand.DeleteAsync(Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.RestGlobalCommand.ModifyAsync``1(System.Action{``0},Discord.RequestOptions)">
- <summary>
- Modifies this <see cref="T:Discord.Rest.RestApplicationCommand"/>.
- </summary>
- <param name="func">The delegate containing the properties to modify the command with.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- The modified command.
- </returns>
- </member>
- <member name="T:Discord.Rest.RestGuildCommand">
- <summary>
- Represents a Rest-based guild application command.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestGuildCommand.GuildId">
- <summary>
- The guild Id where this command originates.
- </summary>
- </member>
- <member name="M:Discord.Rest.RestGuildCommand.DeleteAsync(Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.RestGuildCommand.ModifyAsync``1(System.Action{``0},Discord.RequestOptions)">
- <summary>
- Modifies this <see cref="T:Discord.Rest.RestApplicationCommand"/>.
- </summary>
- <param name="func">The delegate containing the properties to modify the command with.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- The modified command
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuildCommand.GetCommandPermission(Discord.RequestOptions)">
- <summary>
- Gets this commands permissions inside of the current guild.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a
- <see cref="T:Discord.GuildApplicationCommandPermission"/> object defining the permissions of the current slash command.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuildCommand.ModifyCommandPermissions(Discord.ApplicationCommandPermission[],Discord.RequestOptions)">
- <summary>
- Modifies the current command permissions for this guild command.
- </summary>
- <param name="permissions">The permissions to overwrite.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous modification operation. The task result contains a
- <see cref="T:Discord.GuildApplicationCommandPermission"/> object containing the modified permissions.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestGuildCommand.GetGuild(System.Boolean,Discord.RequestOptions)">
- <summary>
- Gets the guild that this slash command resides in.
- </summary>
- <param name="withCounts"><see langword="true"/> if you want the approximate member and presence counts for the guild, otherwise <see langword="false"/>.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a
- <see cref="T:Discord.Rest.RestGuild"/>.
- </returns>
- </member>
- <member name="P:Discord.Rest.RestInvite.ChannelName">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestInvite.GuildName">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestInvite.PresenceCount">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestInvite.MemberCount">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestInvite.ChannelId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestInvite.GuildId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestInvite.Inviter">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestInvite.TargetUser">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestInvite.TargetUserType">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestInvite.Code">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestInvite.Url">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestInvite.UpdateAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestInvite.DeleteAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestInvite.ToString">
- <summary>
- Gets the URL of the invite.
- </summary>
- <returns>
- A string that resolves to the Url of the invite.
- </returns>
- </member>
- <member name="P:Discord.Rest.RestInvite.Discord#IInvite#Guild">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestInvite.Discord#IInvite#Channel">
- <inheritdoc />
- </member>
- <member name="T:Discord.Rest.RestInviteMetadata">
- <summary> Represents additional information regarding the REST-based invite object. </summary>
- </member>
- <member name="P:Discord.Rest.RestInviteMetadata.IsTemporary">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestInviteMetadata.MaxAge">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestInviteMetadata.MaxUses">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestInviteMetadata.Uses">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestInviteMetadata.CreatedAt">
- <inheritdoc />
- </member>
- <member name="T:Discord.Rest.CustomSticker">
- <summary>
- Represents a Rest-based custom sticker within a guild.
- </summary>
- </member>
- <member name="P:Discord.Rest.CustomSticker.AuthorId">
- <summary>
- Gets the users id who uploaded the sticker.
- </summary>
- <remarks>
- In order to get the author id, the bot needs the MANAGE_EMOJIS_AND_STICKERS permission.
- </remarks>
- </member>
- <member name="P:Discord.Rest.CustomSticker.Guild">
- <summary>
- Gets the guild that this custom sticker is in.
- </summary>
- <remarks>
- <b>Note</b>: This property can be <see langword="null"/> if the sticker wasnt fetched from a guild.
- </remarks>
- </member>
- <member name="M:Discord.Rest.CustomSticker.DeleteAsync(Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.CustomSticker.ModifyAsync(System.Action{Discord.StickerProperties},Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="F:Discord.Rest.MessageHelper.InlineCodeRegex">
- <summary>
- Regex used to check if some text is formatted as inline code.
- </summary>
- </member>
- <member name="F:Discord.Rest.MessageHelper.BlockCodeRegex">
- <summary>
- Regex used to check if some text is formatted as a code block.
- </summary>
- </member>
- <member name="M:Discord.Rest.MessageHelper.ModifyAsync(Discord.IMessage,Discord.Rest.BaseDiscordClient,System.Action{Discord.MessageProperties},Discord.RequestOptions)">
- <exception cref="T:System.InvalidOperationException">Only the author of a message may modify the message.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
- </member>
- <member name="T:Discord.Rest.RestFollowupMessage">
- <summary>
- Represents a REST-based follow up message sent by a bot responding to a slash command.
- </summary>
- </member>
- <member name="M:Discord.Rest.RestFollowupMessage.DeleteAsync">
- <summary>
- Deletes this object and all of it's childern.
- </summary>
- <returns>A task that represents the asynchronous delete operation.</returns>
- </member>
- <member name="M:Discord.Rest.RestFollowupMessage.ModifyAsync(System.Action{Discord.MessageProperties},Discord.RequestOptions)">
- <summary>
- Modifies this interaction followup message.
- </summary>
- <remarks>
- This method modifies this message with the specified properties. To see an example of this
- method and what properties are available, please refer to <see cref="T:Discord.MessageProperties"/>.
- </remarks>
- <example>
- <para>The following example replaces the content of the message with <c>Hello World!</c>.</para>
- <code language="cs">
- await msg.ModifyAsync(x => x.Content = "Hello World!");
- </code>
- </example>
- <param name="func">A delegate containing the properties to modify the message with.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous modification operation.
- </returns>
- <exception cref="T:System.InvalidOperationException">The token used to modify/delete this message expired.</exception>
- /// <exception cref="T:Discord.Net.HttpException">Somthing went wrong during the request.</exception>
- </member>
- <member name="T:Discord.Rest.RestInteractionMessage">
- <summary>
- Represents the initial REST-based response to a slash command.
- </summary>
- </member>
- <member name="M:Discord.Rest.RestInteractionMessage.DeleteAsync">
- <summary>
- Deletes this object and all of it's childern.
- </summary>
- <returns>A task that represents the asynchronous delete operation.</returns>
- </member>
- <member name="M:Discord.Rest.RestInteractionMessage.ModifyAsync(System.Action{Discord.MessageProperties},Discord.RequestOptions)">
- <summary>
- Modifies this interaction response
- </summary>
- <remarks>
- This method modifies this message with the specified properties. To see an example of this
- method and what properties are available, please refer to <see cref="T:Discord.MessageProperties"/>.
- </remarks>
- <example>
- <para>The following example replaces the content of the message with <c>Hello World!</c>.</para>
- <code language="cs">
- await msg.ModifyAsync(x => x.Content = "Hello World!");
- </code>
- </example>
- <param name="func">A delegate containing the properties to modify the message with.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous modification operation.
- </returns>
- <exception cref="T:System.InvalidOperationException">The token used to modify/delete this message expired.</exception>
- /// <exception cref="T:Discord.Net.HttpException">Somthing went wrong during the request.</exception>
- </member>
- <member name="T:Discord.Rest.RestMessage">
- <summary>
- Represents a REST-based message.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestMessage.Channel">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestMessage.Author">
- <summary>
- Gets the Author of the message.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestMessage.Source">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestMessage.Content">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestMessage.CreatedAt">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestMessage.IsTTS">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestMessage.IsPinned">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestMessage.IsSuppressed">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestMessage.EditedTimestamp">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestMessage.MentionedEveryone">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestMessage.Attachments">
- <summary>
- Gets a collection of the <see cref="T:Discord.Attachment"/>'s on the message.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestMessage.Embeds">
- <summary>
- Gets a collection of the <see cref="T:Discord.Embed"/>'s on the message.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestMessage.MentionedChannelIds">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestMessage.MentionedRoleIds">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestMessage.MentionedUsers">
- <summary>
- Gets a collection of the mentioned users in the message.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestMessage.Tags">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestMessage.Stickers">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestMessage.Timestamp">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestMessage.Activity">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestMessage.Application">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestMessage.Reference">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestMessage.Flags">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestMessage.Type">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestMessage.Components">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.RestMessage.UpdateAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestMessage.DeleteAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestMessage.ToString">
- <summary>
- Gets the <see cref="P:Discord.Rest.RestMessage.Content"/> of the message.
- </summary>
- <returns>
- A string that is the <see cref="P:Discord.Rest.RestMessage.Content"/> of the message.
- </returns>
- </member>
- <member name="P:Discord.Rest.RestMessage.Discord#IMessage#Attachments">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestMessage.Discord#IMessage#Embeds">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestMessage.Discord#IMessage#MentionedUserIds">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestMessage.Discord#IMessage#Components">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.RestMessage.Discord#IMessage#Stickers">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestMessage.Reactions">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestMessage.AddReactionAsync(Discord.IEmote,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestMessage.RemoveReactionAsync(Discord.IEmote,Discord.IUser,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestMessage.RemoveReactionAsync(Discord.IEmote,System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestMessage.RemoveAllReactionsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestMessage.RemoveAllReactionsForEmoteAsync(Discord.IEmote,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestMessage.GetReactionUsersAsync(Discord.IEmote,System.Int32,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="T:Discord.Rest.RestReaction">
- <summary>
- Represents a REST reaction object.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestReaction.Emote">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestReaction.Count">
- <summary>
- Gets the number of reactions added.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestReaction.Me">
- <summary>
- Gets whether the reactions is added by the user.
- </summary>
- </member>
- <member name="T:Discord.Rest.RestSystemMessage">
- <summary>
- Represents a REST-based system message.
- </summary>
- </member>
- <member name="T:Discord.Rest.RestUserMessage">
- <summary>
- Represents a REST-based message sent by a user.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestUserMessage.IsTTS">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUserMessage.IsPinned">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUserMessage.IsSuppressed">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUserMessage.EditedTimestamp">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUserMessage.MentionedEveryone">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUserMessage.Attachments">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUserMessage.Embeds">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUserMessage.MentionedChannelIds">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUserMessage.MentionedRoleIds">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUserMessage.MentionedUsers">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUserMessage.Tags">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUserMessage.Stickers">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUserMessage.ReferencedMessage">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestUserMessage.ModifyAsync(System.Action{Discord.MessageProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestUserMessage.PinAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestUserMessage.UnpinAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestUserMessage.Resolve(Discord.TagHandling,Discord.TagHandling,Discord.TagHandling,Discord.TagHandling,Discord.TagHandling)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestUserMessage.CrosspostAsync(Discord.RequestOptions)">
- <inheritdoc />
- <exception cref="T:System.InvalidOperationException">This operation may only be called on a <see cref="T:Discord.INewsChannel"/> channel.</exception>
- </member>
- <member name="T:Discord.Rest.Sticker">
- <inheritdoc cref="T:Discord.ISticker"/>
- </member>
- <member name="P:Discord.Rest.Sticker.PackId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.Sticker.Name">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.Sticker.Description">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.Sticker.Tags">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.Sticker.Type">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.Sticker.Available">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.Sticker.SortOrder">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.Sticker.Format">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.Sticker.GetStickerUrl">
- <inheritdoc/>
- </member>
- <member name="T:Discord.Rest.StickerItem">
- <summary>
- Represents a partial sticker received in a message.
- </summary>
- </member>
- <member name="P:Discord.Rest.StickerItem.Name">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Rest.StickerItem.Format">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Rest.StickerItem.ResolveStickerAsync">
- <summary>
- Resolves this sticker item by fetching the <see cref="T:Discord.Rest.Sticker"/> from the API.
- </summary>
- <returns>
- A task representing the download operation, the result of the task is a sticker object.
- </returns>
- </member>
- <member name="T:Discord.Rest.RestApplication">
- <summary>
- Represents a REST-based entity that contains information about a Discord application created via the developer portal.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestApplication.Name">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestApplication.Description">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestApplication.RPCOrigins">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestApplication.Flags">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestApplication.IsBotPublic">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestApplication.BotRequiresCodeGrant">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestApplication.Team">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestApplication.Owner">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestApplication.CreatedAt">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestApplication.IconUrl">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestApplication.UpdateAsync">
- <exception cref="T:System.InvalidOperationException">Unable to update this object from a different application token.</exception>
- </member>
- <member name="M:Discord.Rest.RestApplication.ToString">
- <summary>
- Gets the name of the application.
- </summary>
- <returns>
- Name of the application.
- </returns>
- </member>
- <member name="T:Discord.Rest.RestRole">
- <summary>
- Represents a REST-based role.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestRole.Color">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestRole.IsHoisted">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestRole.IsManaged">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestRole.IsMentionable">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestRole.Name">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestRole.Permissions">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestRole.Position">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestRole.Tags">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestRole.CreatedAt">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestRole.IsEveryone">
- <summary>
- Gets if this role is the @everyone role of the guild or not.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestRole.Mention">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestRole.ModifyAsync(System.Action{Discord.RoleProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestRole.DeleteAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestRole.CompareTo(Discord.IRole)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestRole.ToString">
- <summary>
- Gets the name of the role.
- </summary>
- <returns>
- A string that is the name of the role.
- </returns>
- </member>
- <member name="P:Discord.Rest.RestRole.Discord#IRole#Guild">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestTeam.IconUrl">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestTeam.TeamMembers">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestTeam.Name">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestTeam.OwnerUserId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestTeamMember.MembershipState">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestTeamMember.Permissions">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestTeamMember.TeamId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestTeamMember.User">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestConnection.Id">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestConnection.Type">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestConnection.Name">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestConnection.IsRevoked">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestConnection.IntegrationIds">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestConnection.ToString">
- <summary>
- Gets the name of the connection.
- </summary>
- <returns>
- Name of the connection.
- </returns>
- </member>
- <member name="T:Discord.Rest.RestGroupUser">
- <summary>
- Represents a REST-based group user.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestGroupUser.Discord#IVoiceState#IsDeafened">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGroupUser.Discord#IVoiceState#IsMuted">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGroupUser.Discord#IVoiceState#IsSelfDeafened">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGroupUser.Discord#IVoiceState#IsSelfMuted">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGroupUser.Discord#IVoiceState#IsSuppressed">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGroupUser.Discord#IVoiceState#VoiceChannel">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGroupUser.Discord#IVoiceState#VoiceSessionId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGroupUser.Discord#IVoiceState#IsStreaming">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGroupUser.Discord#IVoiceState#RequestToSpeakTimestamp">
- <inheritdoc />
- </member>
- <member name="T:Discord.Rest.RestGuildUser">
- <summary>
- Represents a REST-based guild user.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestGuildUser.Nickname">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildUser.IsDeafened">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildUser.IsMuted">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildUser.PremiumSince">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildUser.GuildId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildUser.IsPending">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildUser.Hierarchy">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildUser.GuildPermissions">
- <inheritdoc />
- <exception cref="T:System.InvalidOperationException" accessor="get">Resolving permissions requires the parent guild to be downloaded.</exception>
- </member>
- <member name="P:Discord.Rest.RestGuildUser.RoleIds">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildUser.JoinedAt">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildUser.UpdateAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildUser.ModifyAsync(System.Action{Discord.GuildUserProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildUser.KickAsync(System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildUser.AddRoleAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildUser.AddRoleAsync(Discord.IRole,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildUser.AddRolesAsync(System.Collections.Generic.IEnumerable{System.UInt64},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildUser.AddRolesAsync(System.Collections.Generic.IEnumerable{Discord.IRole},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildUser.RemoveRoleAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildUser.RemoveRoleAsync(Discord.IRole,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildUser.RemoveRolesAsync(System.Collections.Generic.IEnumerable{System.UInt64},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildUser.RemoveRolesAsync(System.Collections.Generic.IEnumerable{Discord.IRole},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestGuildUser.GetPermissions(Discord.IGuildChannel)">
- <inheritdoc />
- <exception cref="T:System.InvalidOperationException">Resolving permissions requires the parent guild to be downloaded.</exception>
- </member>
- <member name="P:Discord.Rest.RestGuildUser.Discord#IGuildUser#Guild">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildUser.Discord#IVoiceState#IsSelfDeafened">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildUser.Discord#IVoiceState#IsSelfMuted">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildUser.Discord#IVoiceState#IsSuppressed">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildUser.Discord#IVoiceState#VoiceChannel">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildUser.Discord#IVoiceState#VoiceSessionId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildUser.Discord#IVoiceState#IsStreaming">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestGuildUser.Discord#IVoiceState#RequestToSpeakTimestamp">
- <inheritdoc />
- </member>
- <member name="T:Discord.Rest.RestSelfUser">
- <summary>
- Represents the logged-in REST-based user.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestSelfUser.Email">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestSelfUser.IsVerified">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestSelfUser.IsMfaEnabled">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestSelfUser.Flags">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestSelfUser.PremiumType">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestSelfUser.Locale">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestSelfUser.Update(Discord.API.User)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestSelfUser.UpdateAsync(Discord.RequestOptions)">
- <inheritdoc />
- <exception cref="T:System.InvalidOperationException">Unable to update this object using a different token.</exception>
- </member>
- <member name="M:Discord.Rest.RestSelfUser.ModifyAsync(System.Action{Discord.SelfUserProperties},Discord.RequestOptions)">
- <inheritdoc />
- <exception cref="T:System.InvalidOperationException">Unable to modify this object using a different token.</exception>
- </member>
- <member name="T:Discord.Rest.RestThreadUser">
- <summary>
- Represents a thread user received over the REST api.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestThreadUser.Thread">
- <summary>
- Gets the <see cref="T:Discord.Rest.RestThreadChannel"/> this user is in.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestThreadUser.JoinedAt">
- <summary>
- Gets the timestamp for when this user joined this thread.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestThreadUser.Guild">
- <summary>
- Gets the guild this user is in.
- </summary>
- </member>
- <member name="M:Discord.Rest.RestThreadUser.GetGuildUser">
- <summary>
- Gets the guild user for this thread user.
- </summary>
- <returns>
- A task representing the asynchronous get operation. The task returns a
- <see cref="T:Discord.IGuildUser"/> that represents the current thread user.
- </returns>
- </member>
- <member name="T:Discord.Rest.RestUser">
- <summary>
- Represents a REST-based user.
- </summary>
- </member>
- <member name="P:Discord.Rest.RestUser.IsBot">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUser.Username">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUser.DiscriminatorValue">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUser.AvatarId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUser.BannerId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUser.AccentColor">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUser.PublicFlags">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUser.CreatedAt">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUser.Discriminator">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUser.Mention">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUser.Activity">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUser.Status">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUser.ActiveClients">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUser.Activities">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestUser.IsWebhook">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestUser.UpdateAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestUser.CreateDMChannelAsync(Discord.RequestOptions)">
- <summary>
- Creates a direct message channel to this user.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous get operation. The task result contains a rest DM channel where the user is the recipient.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestUser.GetAvatarUrl(Discord.ImageFormat,System.UInt16)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestUser.GetBannerUrl(Discord.ImageFormat,System.UInt16)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestUser.GetDefaultAvatarUrl">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestUser.ToString">
- <summary>
- Gets the Username#Discriminator of the user.
- </summary>
- <returns>
- A string that resolves to Username#Discriminator of the user.
- </returns>
- </member>
- <member name="M:Discord.Rest.RestUser.Discord#IUser#CreateDMChannelAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhookUser.WebhookId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhookUser.PremiumSince">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhookUser.IsWebhook">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhookUser.GuildId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhookUser.Discord#IGuildUser#Guild">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhookUser.Discord#IGuildUser#RoleIds">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhookUser.Discord#IGuildUser#JoinedAt">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhookUser.Discord#IGuildUser#Nickname">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhookUser.Discord#IGuildUser#IsPending">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhookUser.Discord#IGuildUser#Hierarchy">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhookUser.Discord#IGuildUser#GuildPermissions">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestWebhookUser.Discord#IGuildUser#GetPermissions(Discord.IGuildChannel)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestWebhookUser.Discord#IGuildUser#KickAsync(System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestWebhookUser.Discord#IGuildUser#ModifyAsync(System.Action{Discord.GuildUserProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestWebhookUser.Discord#IGuildUser#AddRoleAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestWebhookUser.Discord#IGuildUser#AddRoleAsync(Discord.IRole,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestWebhookUser.Discord#IGuildUser#AddRolesAsync(System.Collections.Generic.IEnumerable{System.UInt64},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestWebhookUser.Discord#IGuildUser#AddRolesAsync(System.Collections.Generic.IEnumerable{Discord.IRole},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestWebhookUser.Discord#IGuildUser#RemoveRoleAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestWebhookUser.Discord#IGuildUser#RemoveRoleAsync(Discord.IRole,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestWebhookUser.Discord#IGuildUser#RemoveRolesAsync(System.Collections.Generic.IEnumerable{System.UInt64},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestWebhookUser.Discord#IGuildUser#RemoveRolesAsync(System.Collections.Generic.IEnumerable{Discord.IRole},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhookUser.Discord#IVoiceState#IsDeafened">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhookUser.Discord#IVoiceState#IsMuted">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhookUser.Discord#IVoiceState#IsSelfDeafened">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhookUser.Discord#IVoiceState#IsSelfMuted">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhookUser.Discord#IVoiceState#IsSuppressed">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhookUser.Discord#IVoiceState#VoiceChannel">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhookUser.Discord#IVoiceState#VoiceSessionId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhookUser.Discord#IVoiceState#IsStreaming">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhookUser.Discord#IVoiceState#RequestToSpeakTimestamp">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhook.Token">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhook.ChannelId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhook.Name">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhook.AvatarId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhook.GuildId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhook.Creator">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhook.ApplicationId">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhook.CreatedAt">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestWebhook.UpdateAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestWebhook.GetAvatarUrl(Discord.ImageFormat,System.UInt16)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestWebhook.DeleteAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhook.Discord#IWebhook#Guild">
- <inheritdoc />
- </member>
- <member name="P:Discord.Rest.RestWebhook.Discord#IWebhook#Channel">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.RestWebhook.Discord#IWebhook#ModifyAsync(System.Action{Discord.WebhookProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.Rest.ClientExtensions.AddGuildUserAsync(Discord.Rest.BaseDiscordClient,System.UInt64,System.UInt64,System.String,System.Action{Discord.AddGuildUserProperties},Discord.RequestOptions)">
- <summary>
- Adds a user to the specified guild.
- </summary>
- <remarks>
- This method requires you have an OAuth2 access token for the user, requested with the guilds.join scope, and that the bot have the MANAGE_INVITES permission in the guild.
- </remarks>
- <param name="client">The Discord client object.</param>
- <param name="guildId">The snowflake identifier of the guild.</param>
- <param name="userId">The snowflake identifier of the user.</param>
- <param name="accessToken">The OAuth2 access token for the user, requested with the guilds.join scope.</param>
- <param name="func">The delegate containing the properties to be applied to the user upon being added to the guild.</param>
- <param name="options">The options to be used when sending the request.</param>
- </member>
- <member name="T:Discord.Attachment">
- <inheritdoc cref="T:Discord.IAttachment"/>
- </member>
- <member name="P:Discord.Attachment.Id">
- <inheritdoc />
- </member>
- <member name="P:Discord.Attachment.Filename">
- <inheritdoc />
- </member>
- <member name="P:Discord.Attachment.Url">
- <inheritdoc />
- </member>
- <member name="P:Discord.Attachment.ProxyUrl">
- <inheritdoc />
- </member>
- <member name="P:Discord.Attachment.Size">
- <inheritdoc />
- </member>
- <member name="P:Discord.Attachment.Height">
- <inheritdoc />
- </member>
- <member name="P:Discord.Attachment.Width">
- <inheritdoc />
- </member>
- <member name="M:Discord.Attachment.ToString">
- <summary>
- Returns the filename of this attachment.
- </summary>
- <returns>
- A string containing the filename of this attachment.
- </returns>
- </member>
- </members>
- </doc>
|