|
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>Discord.Net.WebSocket</name>
- </assembly>
- <members>
- <member name="F:Discord.API.Gateway.GatewayOpCode.Dispatch">
- <summary> C←S - Used to send most events. </summary>
- </member>
- <member name="F:Discord.API.Gateway.GatewayOpCode.Heartbeat">
- <summary> C↔S - Used to keep the connection alive and measure latency. </summary>
- </member>
- <member name="F:Discord.API.Gateway.GatewayOpCode.Identify">
- <summary> C→S - Used to associate a connection with a token and specify configuration. </summary>
- </member>
- <member name="F:Discord.API.Gateway.GatewayOpCode.PresenceUpdate">
- <summary> C→S - Used to update client's status and current game id. </summary>
- </member>
- <member name="F:Discord.API.Gateway.GatewayOpCode.VoiceStateUpdate">
- <summary> C→S - Used to join a particular voice channel. </summary>
- </member>
- <member name="F:Discord.API.Gateway.GatewayOpCode.VoiceServerPing">
- <summary> C→S - Used to ensure the guild's voice server is alive. </summary>
- </member>
- <member name="F:Discord.API.Gateway.GatewayOpCode.Resume">
- <summary> C→S - Used to resume a connection after a redirect occurs. </summary>
- </member>
- <member name="F:Discord.API.Gateway.GatewayOpCode.Reconnect">
- <summary> C←S - Used to notify a client that they must reconnect to another gateway. </summary>
- </member>
- <member name="F:Discord.API.Gateway.GatewayOpCode.RequestGuildMembers">
- <summary> C→S - Used to request members that were withheld by large_threshold </summary>
- </member>
- <member name="F:Discord.API.Gateway.GatewayOpCode.InvalidSession">
- <summary> C←S - Used to notify the client that their session has expired and cannot be resumed. </summary>
- </member>
- <member name="F:Discord.API.Gateway.GatewayOpCode.Hello">
- <summary> C←S - Used to provide information to the client immediately on connection. </summary>
- </member>
- <member name="F:Discord.API.Gateway.GatewayOpCode.HeartbeatAck">
- <summary> C←S - Used to reply to a client's heartbeat. </summary>
- </member>
- <member name="F:Discord.API.Gateway.GatewayOpCode.GuildSync">
- <summary> C→S - Used to request presence updates from particular guilds. </summary>
- </member>
- <member name="F:Discord.API.Voice.VoiceOpCode.Identify">
- <summary> C→S - Used to associate a connection with a token. </summary>
- </member>
- <member name="F:Discord.API.Voice.VoiceOpCode.SelectProtocol">
- <summary> C→S - Used to specify configuration. </summary>
- </member>
- <member name="F:Discord.API.Voice.VoiceOpCode.Ready">
- <summary> C←S - Used to notify that the voice connection was successful and informs the client of available protocols. </summary>
- </member>
- <member name="F:Discord.API.Voice.VoiceOpCode.Heartbeat">
- <summary> C→S - Used to keep the connection alive and measure latency. </summary>
- </member>
- <member name="F:Discord.API.Voice.VoiceOpCode.SessionDescription">
- <summary> C←S - Used to provide an encryption key to the client. </summary>
- </member>
- <member name="F:Discord.API.Voice.VoiceOpCode.Speaking">
- <summary> C↔S - Used to inform that a certain user is speaking. </summary>
- </member>
- <member name="F:Discord.API.Voice.VoiceOpCode.HeartbeatAck">
- <summary> C←S - Used to reply to a client's heartbeat. </summary>
- </member>
- <member name="F:Discord.API.Voice.VoiceOpCode.Resume">
- <summary> C→S - Used to resume a connection. </summary>
- </member>
- <member name="F:Discord.API.Voice.VoiceOpCode.Hello">
- <summary> C←S - Used to inform the client the heartbeat interval. </summary>
- </member>
- <member name="F:Discord.API.Voice.VoiceOpCode.Resumed">
- <summary> C←S - Used to acknowledge a resumed connection. </summary>
- </member>
- <member name="F:Discord.API.Voice.VoiceOpCode.ClientDisconnect">
- <summary> C←S - Used to notify that a client has disconnected. </summary>
- </member>
- <member name="M:Discord.API.DiscordSocketApiClient.ConnectInternalAsync">
- <exception cref="T:System.InvalidOperationException">The client must be logged in before connecting.</exception>
- <exception cref="T:System.NotSupportedException">This client is not configured with WebSocket support.</exception>
- </member>
- <member name="M:Discord.API.DiscordSocketApiClient.DisconnectInternalAsync(System.Exception)">
- <exception cref="T:System.NotSupportedException">This client is not configured with WebSocket support.</exception>
- </member>
- <member name="T:Discord.WebSocket.BaseSocketClient">
- <summary>
- Represents the base of a WebSocket-based Discord client.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.BaseSocketClient.Latency">
- <summary>
- Gets the estimated round-trip latency, in milliseconds, to the gateway server.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> that represents the round-trip latency to the WebSocket server. Please
- note that this value does not represent a "true" latency for operations such as sending a message.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.BaseSocketClient.Status">
- <summary>
- Gets the status for the logged-in user.
- </summary>
- <returns>
- A status object that represents the user's online presence status.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.BaseSocketClient.Activity">
- <summary>
- Gets the activity for the logged-in user.
- </summary>
- <returns>
- An activity object that represents the user's current activity.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.BaseSocketClient.Rest">
- <summary>
- Provides access to a REST-only client with a shared state from this client.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.BaseSocketClient.DefaultStickerPacks">
- <summary>
- Gets a collection of default stickers.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.BaseSocketClient.CurrentUser">
- <summary>
- Gets the current logged-in user.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.BaseSocketClient.Guilds">
- <summary>
- Gets a collection of guilds that the user is currently in.
- </summary>
- <returns>
- A read-only collection of guilds that the current user is in.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.BaseSocketClient.PrivateChannels">
- <summary>
- Gets a collection of private channels opened in this session.
- </summary>
- <remarks>
- This method will retrieve all private channels (including direct-message, group channel and such) that
- are currently opened in this session.
- <note type="warning">
- This method will not return previously opened private channels outside of the current session! If
- you have just started the client, this may return an empty collection.
- </note>
- </remarks>
- <returns>
- A read-only collection of private channels that the user currently partakes in.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.GetApplicationInfoAsync(Discord.RequestOptions)">
- <summary>
- Gets a Discord application information for the logged-in user.
- </summary>
- <remarks>
- This method reflects your application information you submitted when creating a Discord application via
- the Developer Portal.
- </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 the application
- information.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.GetUser(System.UInt64)">
- <summary>
- Gets a generic user.
- </summary>
- <param name="id">The user snowflake ID.</param>
- <remarks>
- This method gets the user present in the WebSocket cache with the given condition.
- <note type="warning">
- Sometimes a user may return <c>null</c> due to Discord not sending offline users in large guilds
- (i.e. guild with 100+ members) actively. To download users on startup and to see more information
- about this subject, see <see cref="P:Discord.WebSocket.DiscordSocketConfig.AlwaysDownloadUsers" />.
- </note>
- <note>
- This method does not attempt to fetch users that the logged-in user does not have access to (i.e.
- users who don't share mutual guild(s) with the current user). If you wish to get a user that you do
- not have access to, consider using the REST implementation of
- <see cref="M:Discord.Rest.DiscordRestClient.GetUserAsync(System.UInt64,Discord.RequestOptions)" />.
- </note>
- </remarks>
- <returns>
- A generic WebSocket-based user; <c>null</c> when the user cannot be found.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.GetUser(System.String,System.String)">
- <summary>
- Gets a user.
- </summary>
- <remarks>
- This method gets the user present in the WebSocket cache with the given condition.
- <note type="warning">
- Sometimes a user may return <c>null</c> due to Discord not sending offline users in large guilds
- (i.e. guild with 100+ members) actively. To download users on startup and to see more information
- about this subject, see <see cref="P:Discord.WebSocket.DiscordSocketConfig.AlwaysDownloadUsers" />.
- </note>
- <note>
- This method does not attempt to fetch users that the logged-in user does not have access to (i.e.
- users who don't share mutual guild(s) with the current user). If you wish to get a user that you do
- not have access to, consider using the REST implementation of
- <see cref="M:Discord.Rest.DiscordRestClient.GetUserAsync(System.UInt64,Discord.RequestOptions)" />.
- </note>
- </remarks>
- <param name="username">The name of the user.</param>
- <param name="discriminator">The discriminator value of the user.</param>
- <returns>
- A generic WebSocket-based user; <c>null</c> when the user cannot be found.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.GetChannel(System.UInt64)">
- <summary>
- Gets a channel.
- </summary>
- <param name="id">The snowflake identifier of the channel (e.g. `381889909113225237`).</param>
- <returns>
- A generic WebSocket-based channel object (voice, text, category, etc.) associated with the identifier;
- <c>null</c> when the channel cannot be found.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.GetGuild(System.UInt64)">
- <summary>
- Gets a guild.
- </summary>
- <param name="id">The guild snowflake identifier.</param>
- <returns>
- A WebSocket-based guild associated with the snowflake identifier; <c>null</c> when the guild cannot be
- found.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.GetVoiceRegionsAsync(Discord.RequestOptions)">
- <summary>
- Gets all voice regions.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that contains a read-only collection of REST-based voice regions.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.GetVoiceRegionAsync(System.String,Discord.RequestOptions)">
- <summary>
- Gets a voice region.
- </summary>
- <param name="id">The identifier of the voice region (e.g. <c>eu-central</c> ).</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that contains a REST-based voice region associated with the identifier; <c>null</c> if the
- voice region is not found.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.StartAsync">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.StopAsync">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.SetStatusAsync(Discord.UserStatus)">
- <summary>
- Sets the current status of the user (e.g. Online, Do not Disturb).
- </summary>
- <param name="status">The new status to be set.</param>
- <returns>
- A task that represents the asynchronous set operation.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.SetGameAsync(System.String,System.String,Discord.ActivityType)">
- <summary>
- Sets the game of the user.
- </summary>
- <param name="name">The name of the game.</param>
- <param name="streamUrl">If streaming, the URL of the stream. Must be a valid Twitch URL.</param>
- <param name="type">The type of the game.</param>
- <remarks>
- <note type="warning">
- Bot accounts cannot set <see cref="F:Discord.ActivityType.CustomStatus"/> as their activity
- type and it will have no effect.
- </note>
- </remarks>
- <returns>
- A task that represents the asynchronous set operation.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.SetActivityAsync(Discord.IActivity)">
- <summary>
- Sets the <paramref name="activity"/> of the logged-in user.
- </summary>
- <remarks>
- This method sets the <paramref name="activity"/> of the user.
- <note type="note">
- Discord will only accept setting of name and the type of activity.
- </note>
- <note type="warning">
- Bot accounts cannot set <see cref="F:Discord.ActivityType.CustomStatus"/> as their activity
- type and it will have no effect.
- </note>
- <note type="warning">
- Rich Presence cannot be set via this method or client. Rich Presence is strictly limited to RPC
- clients only.
- </note>
- </remarks>
- <param name="activity">The activity to be set.</param>
- <returns>
- A task that represents the asynchronous set operation.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.DownloadUsersAsync(System.Collections.Generic.IEnumerable{Discord.IGuild})">
- <summary>
- Attempts to download users into the user cache for the selected guilds.
- </summary>
- <param name="guilds">The guilds to download the members from.</param>
- <returns>
- A task that represents the asynchronous download operation.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.CreateGuildAsync(System.String,Discord.IVoiceRegion,System.IO.Stream,Discord.RequestOptions)">
- <summary>
- Creates a guild for the logged-in user who is in less than 10 active guilds.
- </summary>
- <remarks>
- This method creates a new guild on behalf of the logged-in user.
- <note type="warning">
- Due to Discord's limitation, this method will only work for users that are in less than 10 guilds.
- </note>
- </remarks>
- <param name="name">The name of the new guild.</param>
- <param name="region">The voice region to create the guild with.</param>
- <param name="jpegIcon">The icon of the guild.</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 guild.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.GetConnectionsAsync(Discord.RequestOptions)">
- <summary>
- Gets the connections that the user has set up.
- </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 connections.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.GetInviteAsync(System.String,Discord.RequestOptions)">
- <summary>
- Gets an invite.
- </summary>
- <param name="inviteId">The invitation identifier.</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 invite information.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.GetStickerAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <summary>
- Gets a sticker.
- </summary>
- <param name="mode">Whether or not to allow downloading from the api.</param>
- <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 <see cref="T:Discord.WebSocket.SocketSticker"/> if found, otherwise <see langword="null"/>.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetApplicationInfoAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetPrivateChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetConnectionsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetInviteAsync(System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetGuildAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetGuildsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#CreateGuildAsync(System.String,Discord.IVoiceRegion,System.IO.Stream,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetUserAsync(System.String,System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetVoiceRegionAsync(System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetVoiceRegionsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.ChannelCreated">
- <summary> Fired when a channel is created. </summary>
- <remarks>
- <para>
- This event is fired when a generic channel has been created. The event handler must return a
- <see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.WebSocket.SocketChannel"/> as its parameter.
- </para>
- <para>
- The newly created channel is passed into the event handler parameter. The given channel type may
- include, but not limited to, Private Channels (DM, Group), Guild Channels (Text, Voice, Category);
- see the derived classes of <see cref="T:Discord.WebSocket.SocketChannel"/> for more details.
- </para>
- </remarks>
- <example>
- <code language="cs" region="ChannelCreated"
- source="..\Discord.Net.Examples\WebSocket\BaseSocketClient.Events.Examples.cs"/>
- </example>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.ChannelDestroyed">
- <summary> Fired when a channel is destroyed. </summary>
- <remarks>
- <para>
- This event is fired when a generic channel has been destroyed. The event handler must return a
- <see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.WebSocket.SocketChannel"/> as its parameter.
- </para>
- <para>
- The destroyed channel is passed into the event handler parameter. The given channel type may
- include, but not limited to, Private Channels (DM, Group), Guild Channels (Text, Voice, Category);
- see the derived classes of <see cref="T:Discord.WebSocket.SocketChannel"/> for more details.
- </para>
- </remarks>
- <example>
- <code language="cs" region="ChannelDestroyed"
- source="..\Discord.Net.Examples\WebSocket\BaseSocketClient.Events.Examples.cs"/>
- </example>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.ChannelUpdated">
- <summary> Fired when a channel is updated. </summary>
- <remarks>
- <para>
- This event is fired when a generic channel has been destroyed. The event handler must return a
- <see cref="T:System.Threading.Tasks.Task"/> and accept 2 <see cref="T:Discord.WebSocket.SocketChannel"/> as its parameters.
- </para>
- <para>
- The original (prior to update) channel is passed into the first <see cref="T:Discord.WebSocket.SocketChannel"/>, while
- the updated channel is passed into the second. The given channel type may include, but not limited
- to, Private Channels (DM, Group), Guild Channels (Text, Voice, Category); see the derived classes of
- <see cref="T:Discord.WebSocket.SocketChannel"/> for more details.
- </para>
- </remarks>
- <example>
- <code language="cs" region="ChannelUpdated"
- source="..\Discord.Net.Examples\WebSocket\BaseSocketClient.Events.Examples.cs"/>
- </example>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.MessageReceived">
- <summary> Fired when a message is received. </summary>
- <remarks>
- <para>
- This event is fired when a message is received. The event handler must return a
- <see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.WebSocket.SocketMessage"/> as its parameter.
- </para>
- <para>
- The message that is sent to the client is passed into the event handler parameter as
- <see cref="T:Discord.WebSocket.SocketMessage"/>. This message may be a system message (i.e.
- <see cref="T:Discord.WebSocket.SocketSystemMessage"/>) or a user message (i.e. <see cref="T:Discord.WebSocket.SocketUserMessage"/>. See the
- derived classes of <see cref="T:Discord.WebSocket.SocketMessage"/> for more details.
- </para>
- </remarks>
- <example>
- <para>The example below checks if the newly received message contains the target user.</para>
- <code language="cs" region="MessageReceived"
- source="..\Discord.Net.Examples\WebSocket\BaseSocketClient.Events.Examples.cs"/>
- </example>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.MessageDeleted">
- <summary> Fired when a message is deleted. </summary>
- <remarks>
- <para>
- This event is fired when a message is deleted. The event handler must return a
- <see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.Cacheable`2"/> and
- <see cref="T:Discord.WebSocket.ISocketMessageChannel"/> as its parameters.
- </para>
- <para>
- <note type="important">
- It is not possible to retrieve the message via
- <see cref="M:Discord.Cacheable`2.DownloadAsync"/>; the message cannot be retrieved by Discord
- after the message has been deleted.
- </note>
- If caching is enabled via <see cref="T:Discord.WebSocket.DiscordSocketConfig"/>, the
- <see cref="T:Discord.Cacheable`2"/> entity will contain the deleted message; otherwise, in event
- that the message cannot be retrieved, the snowflake ID of the message is preserved in the
- <see cref="T:System.UInt64"/>.
- </para>
- <para>
- The source channel of the removed message will be passed into the
- <see cref="T:Discord.WebSocket.ISocketMessageChannel"/> parameter.
- </para>
- </remarks>
- <example>
- <code language="cs" region="MessageDeleted"
- source="..\Discord.Net.Examples\WebSocket\BaseSocketClient.Events.Examples.cs" />
- </example>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.MessagesBulkDeleted">
- <summary> Fired when multiple messages are bulk deleted. </summary>
- <remarks>
- <note>
- The <see cref="E:Discord.WebSocket.BaseSocketClient.MessageDeleted"/> event will not be fired for individual messages contained in this event.
- </note>
- <para>
- This event is fired when multiple messages are bulk deleted. The event handler must return a
- <see cref="T:System.Threading.Tasks.Task"/> and accept an <see cref="T:System.Collections.Generic.IReadOnlyCollection`1"/> and
- <see cref="T:Discord.WebSocket.ISocketMessageChannel"/> as its parameters.
- </para>
- <para>
- <note type="important">
- It is not possible to retrieve the message via
- <see cref="M:Discord.Cacheable`2.DownloadAsync"/>; the message cannot be retrieved by Discord
- after the message has been deleted.
- </note>
- If caching is enabled via <see cref="T:Discord.WebSocket.DiscordSocketConfig"/>, the
- <see cref="T:Discord.Cacheable`2"/> entity will contain the deleted message; otherwise, in event
- that the message cannot be retrieved, the snowflake ID of the message is preserved in the
- <see cref="T:System.UInt64"/>.
- </para>
- <para>
- The source channel of the removed message will be passed into the
- <see cref="T:Discord.WebSocket.ISocketMessageChannel"/> parameter.
- </para>
- </remarks>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.MessageUpdated">
- <summary> Fired when a message is updated. </summary>
- <remarks>
- <para>
- This event is fired when a message is updated. The event handler must return a
- <see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.Cacheable`2"/>, <see cref="T:Discord.WebSocket.SocketMessage"/>,
- and <see cref="T:Discord.WebSocket.ISocketMessageChannel"/> as its parameters.
- </para>
- <para>
- If caching is enabled via <see cref="T:Discord.WebSocket.DiscordSocketConfig"/>, the
- <see cref="T:Discord.Cacheable`2"/> entity will contain the original message; otherwise, in event
- that the message cannot be retrieved, the snowflake ID of the message is preserved in the
- <see cref="T:System.UInt64"/>.
- </para>
- <para>
- The updated message will be passed into the <see cref="T:Discord.WebSocket.SocketMessage"/> parameter.
- </para>
- <para>
- The source channel of the updated message will be passed into the
- <see cref="T:Discord.WebSocket.ISocketMessageChannel"/> parameter.
- </para>
- </remarks>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.ReactionAdded">
- <summary> Fired when a reaction is added to a message. </summary>
- <remarks>
- <para>
- This event is fired when a reaction is added to a user message. The event handler must return a
- <see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.Cacheable`2"/>, an
- <see cref="T:Discord.WebSocket.ISocketMessageChannel"/>, and a <see cref="T:Discord.WebSocket.SocketReaction"/> as its parameter.
- </para>
- <para>
- If caching is enabled via <see cref="T:Discord.WebSocket.DiscordSocketConfig"/>, the
- <see cref="T:Discord.Cacheable`2"/> entity will contain the original message; otherwise, in event
- that the message cannot be retrieved, the snowflake ID of the message is preserved in the
- <see cref="T:System.UInt64"/>.
- </para>
- <para>
- The source channel of the reaction addition will be passed into the
- <see cref="T:Discord.WebSocket.ISocketMessageChannel"/> parameter.
- </para>
- <para>
- The reaction that was added will be passed into the <see cref="T:Discord.WebSocket.SocketReaction"/> parameter.
- </para>
- <note>
- When fetching the reaction from this event, a user may not be provided under
- <see cref="P:Discord.WebSocket.SocketReaction.User"/>. Please see the documentation of the property for more
- information.
- </note>
- </remarks>
- <example>
- <code language="cs" region="ReactionAdded"
- source="..\Discord.Net.Examples\WebSocket\BaseSocketClient.Events.Examples.cs"/>
- </example>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.ReactionRemoved">
- <summary> Fired when a reaction is removed from a message. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.ReactionsCleared">
- <summary> Fired when all reactions to a message are cleared. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.ReactionsRemovedForEmote">
- <summary>
- Fired when all reactions to a message with a specific emote are removed.
- </summary>
- <remarks>
- <para>
- This event is fired when all reactions to a message with a specific emote are removed.
- The event handler must return a <see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.WebSocket.ISocketMessageChannel"/> and
- a <see cref="T:Discord.IEmote"/> as its parameters.
- </para>
- <para>
- The channel where this message was sent will be passed into the <see cref="T:Discord.WebSocket.ISocketMessageChannel"/> parameter.
- </para>
- <para>
- The emoji that all reactions had and were removed will be passed into the <see cref="T:Discord.IEmote"/> parameter.
- </para>
- </remarks>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.RoleCreated">
- <summary> Fired when a role is created. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.RoleDeleted">
- <summary> Fired when a role is deleted. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.RoleUpdated">
- <summary> Fired when a role is updated. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.JoinedGuild">
- <summary> Fired when the connected account joins a guild. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.LeftGuild">
- <summary> Fired when the connected account leaves a guild. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.GuildAvailable">
- <summary> Fired when a guild becomes available. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.GuildUnavailable">
- <summary> Fired when a guild becomes unavailable. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.GuildMembersDownloaded">
- <summary> Fired when offline guild members are downloaded. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.GuildUpdated">
- <summary> Fired when a guild is updated. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.UserJoined">
- <summary> Fired when a user joins a guild. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.UserLeft">
- <summary> Fired when a user leaves a guild. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.UserBanned">
- <summary> Fired when a user is banned from a guild. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.UserUnbanned">
- <summary> Fired when a user is unbanned from a guild. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.UserUpdated">
- <summary> Fired when a user is updated. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.GuildMemberUpdated">
- <summary> Fired when a guild member is updated, or a member presence is updated. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.UserVoiceStateUpdated">
- <summary> Fired when a user joins, leaves, or moves voice channels. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.VoiceServerUpdated">
- <summary> Fired when the bot connects to a Discord voice server. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.CurrentUserUpdated">
- <summary> Fired when the connected account is updated. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.UserIsTyping">
- <summary> Fired when a user starts typing. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.RecipientAdded">
- <summary> Fired when a user joins a group channel. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.RecipientRemoved">
- <summary> Fired when a user is removed from a group channel. </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.InviteCreated">
- <summary>
- Fired when an invite is created.
- </summary>
- <remarks>
- <para>
- This event is fired when an invite is created. The event handler must return a
- <see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.WebSocket.SocketInvite"/> as its parameter.
- </para>
- <para>
- The invite created will be passed into the <see cref="T:Discord.WebSocket.SocketInvite"/> parameter.
- </para>
- </remarks>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.InviteDeleted">
- <summary>
- Fired when an invite is deleted.
- </summary>
- <remarks>
- <para>
- This event is fired when an invite is deleted. The event handler must return
- a <see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.WebSocket.SocketGuildChannel"/> and
- <see cref="T:System.String"/> as its parameter.
- </para>
- <para>
- The channel where this invite was created will be passed into the <see cref="T:Discord.WebSocket.SocketGuildChannel"/> parameter.
- </para>
- <para>
- The code of the deleted invite will be passed into the <see cref="T:System.String"/> parameter.
- </para>
- </remarks>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.InteractionCreated">
- <summary>
- Fired when an Interaction is created. This event covers all types of interactions including but not limited to: buttons, select menus, slash commands.
- </summary>
- <remarks>
- <para>
- This event is fired when an interaction is created. The event handler must return a
- <see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.WebSocket.SocketInteraction"/> as its parameter.
- </para>
- <para>
- The interaction created will be passed into the <see cref="T:Discord.WebSocket.SocketInteraction"/> parameter.
- </para>
- </remarks>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.ButtonExecuted">
- <summary>
- Fired when a button is clicked and its interaction is received.
- </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.SelectMenuExecuted">
- <summary>
- Fired when a select menu is used and its interaction is received.
- </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.SlashCommandExecuted">
- <summary>
- Fired when a slash command is used and its interaction is received.
- </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.UserCommandExecuted">
- <summary>
- Fired when a user command is used and its interaction is received.
- </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.MessageCommandExecuted">
- <summary>
- Fired when a message command is used and its interaction is received.
- </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.ApplicationCommandCreated">
- <summary>
- Fired when a guild application command is created.
- </summary>
- <remarks>
- <para>
- This event is fired when an application command is created. The event handler must return a
- <see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.WebSocket.SocketApplicationCommand"/> as its parameter.
- </para>
- <para>
- The command that was deleted will be passed into the <see cref="T:Discord.WebSocket.SocketApplicationCommand"/> parameter.
- </para>
- <note>
- <b>This event is an undocumented discord event and may break at any time, its not recommended to rely on this event</b>
- </note>
- </remarks>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.ApplicationCommandUpdated">
- <summary>
- Fired when a guild application command is updated.
- </summary>
- <remarks>
- <para>
- This event is fired when an application command is updated. The event handler must return a
- <see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.WebSocket.SocketApplicationCommand"/> as its parameter.
- </para>
- <para>
- The command that was deleted will be passed into the <see cref="T:Discord.WebSocket.SocketApplicationCommand"/> parameter.
- </para>
- <note>
- <b>This event is an undocumented discord event and may break at any time, its not recommended to rely on this event</b>
- </note>
- </remarks>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.ApplicationCommandDeleted">
- <summary>
- Fired when a guild application command is deleted.
- </summary>
- <remarks>
- <para>
- This event is fired when an application command is deleted. The event handler must return a
- <see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.WebSocket.SocketApplicationCommand"/> as its parameter.
- </para>
- <para>
- The command that was deleted will be passed into the <see cref="T:Discord.WebSocket.SocketApplicationCommand"/> parameter.
- </para>
- <note>
- <b>This event is an undocumented discord event and may break at any time, its not recommended to rely on this event</b>
- </note>
- </remarks>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.ThreadCreated">
- <summary>
- Fired when a thread is created within a guild, or when the current user is added to a thread.
- </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.ThreadUpdated">
- <summary>
- Fired when a thread is updated within a guild.
- </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.ThreadDeleted">
- <summary>
- Fired when a thread is deleted.
- </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.ThreadMemberJoined">
- <summary>
- Fired when a user joins a thread
- </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.ThreadMemberLeft">
- <summary>
- Fired when a user leaves a thread
- </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.StageStarted">
- <summary>
- Fired when a stage is started.
- </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.StageEnded">
- <summary>
- Fired when a stage ends.
- </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.StageUpdated">
- <summary>
- Fired when a stage is updated.
- </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.RequestToSpeak">
- <summary>
- Fired when a user requests to speak within a stage channel.
- </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.SpeakerAdded">
- <summary>
- Fired when a speaker is added in a stage channel.
- </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.SpeakerRemoved">
- <summary>
- Fired when a speaker is removed from a stage channel.
- </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.GuildStickerCreated">
- <summary>
- Fired when a sticker in a guild is created.
- </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.GuildStickerUpdated">
- <summary>
- Fired when a sticker in a guild is updated.
- </summary>
- </member>
- <member name="E:Discord.WebSocket.BaseSocketClient.GuildStickerDeleted">
- <summary>
- Fired when a sticker in a guild is deleted.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.DiscordShardedClient.Latency">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.DiscordShardedClient.Status">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.DiscordShardedClient.Activity">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.DiscordShardedClient.DefaultStickerPacks">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.DiscordShardedClient.Guilds">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.DiscordShardedClient.PrivateChannels">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.DiscordShardedClient.Rest">
- <summary>
- Provides access to a REST-only client with a shared state from this client.
- </summary>
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.#ctor">
- <summary> Creates a new REST/WebSocket Discord client. </summary>
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.#ctor(Discord.WebSocket.DiscordSocketConfig)">
- <summary> Creates a new REST/WebSocket Discord client. </summary>
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.#ctor(System.Int32[])">
- <summary> Creates a new REST/WebSocket Discord client. </summary>
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.#ctor(System.Int32[],Discord.WebSocket.DiscordSocketConfig)">
- <summary> Creates a new REST/WebSocket Discord client. </summary>
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.StartAsync">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.StopAsync">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.GetApplicationInfoAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.GetGuild(System.UInt64)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.GetChannel(System.UInt64)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.GetStickerAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.GetUser(System.UInt64)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.GetUser(System.String,System.String)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.GetVoiceRegionsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.GetVoiceRegionAsync(System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.DownloadUsersAsync(System.Collections.Generic.IEnumerable{Discord.IGuild})">
- <inheritdoc />
- <exception cref="T:System.ArgumentNullException"><paramref name="guilds"/> is <see langword="null"/></exception>
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.SetStatusAsync(Discord.UserStatus)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.SetGameAsync(System.String,System.String,Discord.ActivityType)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.SetActivityAsync(Discord.IActivity)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetApplicationInfoAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetPrivateChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetConnectionsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetInviteAsync(System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetGuildAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetGuildsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#CreateGuildAsync(System.String,Discord.IVoiceRegion,System.IO.Stream,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetUserAsync(System.String,System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetVoiceRegionsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetVoiceRegionAsync(System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="E:Discord.WebSocket.DiscordShardedClient.ShardConnected">
- <summary> Fired when a shard is connected to the Discord gateway. </summary>
- </member>
- <member name="E:Discord.WebSocket.DiscordShardedClient.ShardDisconnected">
- <summary> Fired when a shard is disconnected from the Discord gateway. </summary>
- </member>
- <member name="E:Discord.WebSocket.DiscordShardedClient.ShardReady">
- <summary> Fired when a guild data for a shard has finished downloading. </summary>
- </member>
- <member name="E:Discord.WebSocket.DiscordShardedClient.ShardLatencyUpdated">
- <summary> Fired when a shard receives a heartbeat from the Discord gateway. </summary>
- </member>
- <member name="T:Discord.WebSocket.DiscordSocketClient">
- <summary>
- Represents a WebSocket-based Discord client.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketClient.Rest">
- <summary>
- Provides access to a REST-only client with a shared state from this client.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketClient.ShardId">
- <summary> Gets the shard of of this client. </summary>
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketClient.ConnectionState">
- <summary> Gets the current connection state of this client. </summary>
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketClient.Latency">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketClient.Status">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketClient.Activity">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketClient.Guilds">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketClient.DefaultStickerPacks">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketClient.PrivateChannels">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketClient.DMChannels">
- <summary>
- Gets a collection of direct message channels opened in this session.
- </summary>
- <remarks>
- This method returns a collection of currently opened direct message channels.
- <note type="warning">
- This method will not return previously opened DM channels outside of the current session! If you
- have just started the client, this may return an empty collection.
- </note>
- </remarks>
- <returns>
- A collection of DM channels that have been opened in this session.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketClient.GroupChannels">
- <summary>
- Gets a collection of group channels opened in this session.
- </summary>
- <remarks>
- This method returns a collection of currently opened group channels.
- <note type="warning">
- This method will not return previously opened group channels outside of the current session! If you
- have just started the client, this may return an empty collection.
- </note>
- </remarks>
- <returns>
- A collection of group channels that have been opened in this session.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.#ctor">
- <summary>
- Initializes a new REST/WebSocket-based Discord client.
- </summary>
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.#ctor(Discord.WebSocket.DiscordSocketConfig)">
- <summary>
- Initializes a new REST/WebSocket-based Discord client with the provided configuration.
- </summary>
- <param name="config">The configuration to be used with the client.</param>
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.Dispose(System.Boolean)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.OnLogoutAsync">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.StartAsync">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.StopAsync">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.GetApplicationInfoAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.GetGuild(System.UInt64)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.GetChannel(System.UInt64)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.GetChannelAsync(System.UInt64,Discord.RequestOptions)">
- <summary>
- Gets a generic channel from the cache or does a rest request if unavailable.
- </summary>
- <example>
- <code language="cs" title="Example method">
- var channel = await _client.GetChannelAsync(381889909113225237);
- if (channel != null && channel is IMessageChannel msgChannel)
- {
- await msgChannel.SendMessageAsync($"{msgChannel} is created at {msgChannel.CreatedAt}");
- }
- </code>
- </example>
- <param name="id">The snowflake identifier of the channel (e.g. `381889909113225237`).</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 channel associated
- with the snowflake identifier; <c>null</c> when the channel cannot be found.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.GetUserAsync(System.UInt64,Discord.RequestOptions)">
- <summary>
- Gets a user from the cache or does a rest request if unavailable.
- </summary>
- <example>
- <code language="cs" title="Example method">
- var user = await _client.GetUserAsync(168693960628371456);
- if (user != null)
- Console.WriteLine($"{user} is created at {user.CreatedAt}.";
- </code>
- </example>
- <param name="id">The snowflake identifier of the user (e.g. `168693960628371456`).</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 user associated with
- the snowflake identifier; <c>null</c> if the user is not found.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.PurgeChannelCache">
- <summary>
- Clears all cached channels from the client.
- </summary>
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.PurgeDMChannelCache">
- <summary>
- Clears cached DM channels from the client.
- </summary>
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.GetUser(System.UInt64)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.GetUser(System.String,System.String)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.GetGlobalApplicationCommandAsync(System.UInt64,Discord.RequestOptions)">
- <summary>
- Gets a global application command.
- </summary>
- <param name="id">The id of the command.</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 the application command if found, otherwise
- <see langword="null"/>.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.GetGlobalApplicationCommandsAsync(Discord.RequestOptions)">
- <summary>
- Gets a collection of all global 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 global
- application commands.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.PurgeUserCache">
- <summary>
- Clears cached users from the client.
- </summary>
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.GetStickerAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.GetSticker(System.UInt64)">
- <summary>
- Gets a sticker.
- </summary>
- <param name="id">The unique identifier of the sticker.</param>
- <returns>A sticker if found, otherwise <see langword="null"/>.</returns>
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.GetVoiceRegionsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.GetVoiceRegionAsync(System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.DownloadUsersAsync(System.Collections.Generic.IEnumerable{Discord.IGuild})">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.SetStatusAsync(Discord.UserStatus)">
- <inheritdoc />
- <example>
- The following example sets the status of the current user to Do Not Disturb.
- <code language="cs">
- await client.SetStatusAsync(UserStatus.DoNotDisturb);
- </code>
- </example>
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.SetGameAsync(System.String,System.String,Discord.ActivityType)">
- <inheritdoc />
- <example>
- <para>
- The following example sets the activity of the current user to the specified game name.
- <code language="cs">
- await client.SetGameAsync("A Strange Game");
- </code>
- </para>
- <para>
- The following example sets the activity of the current user to a streaming status.
- <code language="cs">
- await client.SetGameAsync("Great Stream 10/10", "https://twitch.tv/MyAmazingStream1337", ActivityType.Streaming);
- </code>
- </para>
- </example>
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.SetActivityAsync(Discord.IActivity)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.AddPrivateChannel(Discord.API.Channel,Discord.WebSocket.ClientState)">
- <exception cref="T:System.InvalidOperationException">Unexpected channel type is created.</exception>
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.Discord#IDiscordClient#GetApplicationInfoAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.Discord#IDiscordClient#GetChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.Discord#IDiscordClient#GetPrivateChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.Discord#IDiscordClient#GetDMChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.Discord#IDiscordClient#GetGroupChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.Discord#IDiscordClient#GetConnectionsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.Discord#IDiscordClient#GetInviteAsync(System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.Discord#IDiscordClient#GetGuildAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.Discord#IDiscordClient#GetGuildsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.Discord#IDiscordClient#CreateGuildAsync(System.String,Discord.IVoiceRegion,System.IO.Stream,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.Discord#IDiscordClient#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.Discord#IDiscordClient#GetUserAsync(System.String,System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.Discord#IDiscordClient#GetVoiceRegionsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.Discord#IDiscordClient#GetVoiceRegionAsync(System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.Discord#IDiscordClient#GetGlobalApplicationCommandAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.Discord#IDiscordClient#GetGlobalApplicationCommandsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.Discord#IDiscordClient#StartAsync">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketClient.Discord#IDiscordClient#StopAsync">
- <inheritdoc />
- </member>
- <member name="E:Discord.WebSocket.DiscordSocketClient.Connected">
- <summary> Fired when connected to the Discord gateway. </summary>
- </member>
- <member name="E:Discord.WebSocket.DiscordSocketClient.Disconnected">
- <summary> Fired when disconnected to the Discord gateway. </summary>
- </member>
- <member name="E:Discord.WebSocket.DiscordSocketClient.Ready">
- <summary>
- Fired when guild data has finished downloading.
- </summary>
- <remarks>
- It is possible that some guilds might be unsynced if <see cref="P:Discord.WebSocket.DiscordSocketConfig.MaxWaitBetweenGuildAvailablesBeforeReady" />
- was not long enough to receive all GUILD_AVAILABLEs before READY.
- </remarks>
- </member>
- <member name="E:Discord.WebSocket.DiscordSocketClient.LatencyUpdated">
- <summary> Fired when a heartbeat is received from the Discord gateway. </summary>
- </member>
- <member name="T:Discord.WebSocket.DiscordSocketConfig">
- <summary>
- Represents a configuration class for <see cref="T:Discord.WebSocket.DiscordSocketClient"/>.
- </summary>
- <remarks>
- This configuration, based on <see cref="T:Discord.Rest.DiscordRestConfig"/>, helps determine several key configurations the
- socket client depend on. For instance, shards and connection timeout.
- </remarks>
- <example>
- The following config enables the message cache and configures the client to always download user upon guild
- availability.
- <code language="cs">
- var config = new DiscordSocketConfig
- {
- AlwaysDownloadUsers = true,
- MessageCacheSize = 100
- };
- var client = new DiscordSocketClient(config);
- </code>
- </example>
- </member>
- <member name="F:Discord.WebSocket.DiscordSocketConfig.GatewayEncoding">
- <summary>
- Returns the encoding gateway should use.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketConfig.GatewayHost">
- <summary>
- Gets or sets the WebSocket host to connect to. If <c>null</c>, the client will use the
- /gateway endpoint.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketConfig.ConnectionTimeout">
- <summary>
- Gets or sets the time, in milliseconds, to wait for a connection to complete before aborting.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketConfig.ShardId">
- <summary>
- Gets or sets the ID for this shard. Must be less than <see cref="P:Discord.WebSocket.DiscordSocketConfig.TotalShards"/>.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketConfig.TotalShards">
- <summary>
- Gets or sets the total number of shards for this application.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketConfig.MessageCacheSize">
- <summary>
- Gets or sets the number of messages per channel that should be kept in cache. Setting this to zero
- disables the message cache entirely.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketConfig.LargeThreshold">
- <summary>
- Gets or sets the max number of users a guild may have for offline users to be included in the READY
- packet. The maximum value allowed is 250.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketConfig.WebSocketProvider">
- <summary>
- Gets or sets the provider used to generate new WebSocket connections.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketConfig.UdpSocketProvider">
- <summary>
- Gets or sets the provider used to generate new UDP sockets.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketConfig.AlwaysDownloadUsers">
- <summary>
- Gets or sets whether or not all users should be downloaded as guilds come available.
- </summary>
- <remarks>
- <para>
- By default, the Discord gateway will only send offline members if a guild has less than a certain number
- of members (determined by <see cref="P:Discord.WebSocket.DiscordSocketConfig.LargeThreshold"/> in this library). This behaviour is why
- sometimes a user may be missing from the WebSocket cache for collections such as
- <see cref="P:Discord.WebSocket.SocketGuild.Users"/>.
- </para>
- <para>
- This property ensures that whenever a guild becomes available (determined by
- <see cref="E:Discord.WebSocket.BaseSocketClient.GuildAvailable"/>), incomplete user chunks will be
- downloaded to the WebSocket cache.
- </para>
- <para>
- For more information, please see
- <see href="https://discord.com/developers/docs/topics/gateway#request-guild-members">Request Guild Members</see>
- on the official Discord API documentation.
- </para>
- <note>
- Please note that it can be difficult to fill the cache completely on large guilds depending on the
- traffic. If you are using the command system, the default user TypeReader may fail to find the user
- due to this issue. This may be resolved at v3 of the library. Until then, you may want to consider
- overriding the TypeReader and use
- <see cref="M:Discord.Rest.DiscordRestClient.GetUserAsync(System.UInt64,Discord.RequestOptions)"/>
- or <see cref="M:Discord.Rest.DiscordRestClient.GetGuildUserAsync(System.UInt64,System.UInt64,Discord.RequestOptions)"/>
- as a backup.
- </note>
- </remarks>
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketConfig.HandlerTimeout">
- <summary>
- Gets or sets the timeout for event handlers, in milliseconds, after which a warning will be logged.
- Setting this property to <c>null</c>disables this check.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketConfig.IdentifyMaxConcurrency">
- <summary>
- Gets or sets the maximum identify concurrency.
- </summary>
- <remarks>
- This information is provided by Discord.
- It is only used when using a <see cref="T:Discord.WebSocket.DiscordShardedClient"/> and auto-sharding is disabled.
- </remarks>
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketConfig.MaxWaitBetweenGuildAvailablesBeforeReady">
- <summary>
- Gets or sets the maximum wait time in milliseconds between GUILD_AVAILABLE events before firing READY.
- If zero, READY will fire as soon as it is received and all guilds will be unavailable.
- </summary>
- <remarks>
- <para>This property is measured in milliseconds; negative values will throw an exception.</para>
- <para>If a guild is not received before READY, it will be unavailable.</para>
- </remarks>
- <returns>
- A <see cref="T:System.Int32"/> representing the maximum wait time in milliseconds between GUILD_AVAILABLE events
- before firing READY.
- </returns>
- <exception cref="T:System.ArgumentException">Value must be at least 0.</exception>
- </member>
- <member name="P:Discord.WebSocket.DiscordSocketConfig.GatewayIntents">
- <summary>
- Gets or sets gateway intents to limit what events are sent from Discord.
- The default is <see cref="F:Discord.GatewayIntents.AllUnprivileged"/>.
- </summary>
- <remarks>
- For more information, please see
- <see href="https://discord.com/developers/docs/topics/gateway#gateway-intents">GatewayIntents</see>
- on the official Discord API documentation.
- </remarks>
- </member>
- <member name="M:Discord.WebSocket.DiscordSocketConfig.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Discord.WebSocket.DiscordSocketConfig"/> class with the default configuration.
- </summary>
- </member>
- <member name="T:Discord.WebSocket.ISocketAudioChannel">
- <summary>
- Represents a generic WebSocket-based audio channel.
- </summary>
- </member>
- <member name="T:Discord.WebSocket.ISocketMessageChannel">
- <summary>
- Represents a generic WebSocket-based channel that can send and receive messages.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.ISocketMessageChannel.CachedMessages">
- <summary>
- Gets all messages in this channel's cache.
- </summary>
- <returns>
- A read-only collection of WebSocket-based messages.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.ISocketMessageChannel.SendMessageAsync(System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[],Discord.Embed[])">
- <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[],Discord.Embed[])"/>.
- 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>
- <param name="embeds">A array of <see cref="T:Discord.Embed"/>s to send with this response. Max 10.</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.WebSocket.ISocketMessageChannel.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 file.</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.WebSocket.ISocketMessageChannel.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 file.</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.WebSocket.ISocketMessageChannel.GetCachedMessage(System.UInt64)">
- <summary>
- Gets a cached message from this channel.
- </summary>
- <remarks>
- <note type="warning">
- This method requires the use of cache, which is not enabled by default; if caching is not enabled,
- this method will always return <c>null</c>. Please refer to
- <see cref="P:Discord.WebSocket.DiscordSocketConfig.MessageCacheSize" /> for more details.
- </note>
- <para>
- This method retrieves the message from the local WebSocket cache and does not send any additional
- request to Discord. This message may be a message that has been deleted.
- </para>
- </remarks>
- <param name="id">The snowflake identifier of the message.</param>
- <returns>
- A WebSocket-based message object; <c>null</c> if it does not exist in the cache or if caching is not
- enabled.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.ISocketMessageChannel.GetCachedMessages(System.Int32)">
- <summary>
- Gets the last N cached messages from this message channel.
- </summary>
- <remarks>
- <note type="warning">
- This method requires the use of cache, which is not enabled by default; if caching is not enabled,
- this method will always return an empty collection. Please refer to
- <see cref="P:Discord.WebSocket.DiscordSocketConfig.MessageCacheSize" /> for more details.
- </note>
- <para>
- This method retrieves the message(s) from the local WebSocket cache and does not send any additional
- request to Discord. This read-only collection may include messages that have been deleted. The
- maximum number of messages that can be retrieved from this method depends on the
- <see cref="P:Discord.WebSocket.DiscordSocketConfig.MessageCacheSize" /> set.
- </para>
- </remarks>
- <param name="limit">The number of messages to get.</param>
- <returns>
- A read-only collection of WebSocket-based messages.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.ISocketMessageChannel.GetCachedMessages(System.UInt64,Discord.Direction,System.Int32)">
- <summary>
- Gets the last N cached messages starting from a certain message in this message channel.
- </summary>
- <remarks>
- <note type="warning">
- This method requires the use of cache, which is not enabled by default; if caching is not enabled,
- this method will always return an empty collection. Please refer to
- <see cref="P:Discord.WebSocket.DiscordSocketConfig.MessageCacheSize" /> for more details.
- </note>
- <para>
- This method retrieves the message(s) from the local WebSocket cache and does not send any additional
- request to Discord. This read-only collection may include messages that have been deleted. The
- maximum number of messages that can be retrieved from this method depends on the
- <see cref="P:Discord.WebSocket.DiscordSocketConfig.MessageCacheSize" /> set.
- </para>
- </remarks>
- <param name="fromMessageId">The message ID to start the fetching from.</param>
- <param name="dir">The direction of which the message should be gotten from.</param>
- <param name="limit">The number of messages to get.</param>
- <returns>
- A read-only collection of WebSocket-based messages.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.ISocketMessageChannel.GetCachedMessages(Discord.IMessage,Discord.Direction,System.Int32)">
- <summary>
- Gets the last N cached messages starting from a certain message in this message channel.
- </summary>
- <remarks>
- <note type="warning">
- This method requires the use of cache, which is not enabled by default; if caching is not enabled,
- this method will always return an empty collection. Please refer to
- <see cref="P:Discord.WebSocket.DiscordSocketConfig.MessageCacheSize" /> for more details.
- </note>
- <para>
- This method retrieves the message(s) from the local WebSocket cache and does not send any additional
- request to Discord. This read-only collection may include messages that have been deleted. The
- maximum number of messages that can be retrieved from this method depends on the
- <see cref="P:Discord.WebSocket.DiscordSocketConfig.MessageCacheSize" /> set.
- </para>
- </remarks>
- <param name="fromMessage">The message to start the fetching from.</param>
- <param name="dir">The direction of which the message should be gotten from.</param>
- <param name="limit">The number of messages to get.</param>
- <returns>
- A read-only collection of WebSocket-based messages.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.ISocketMessageChannel.GetPinnedMessagesAsync(Discord.RequestOptions)">
- <summary>
- Gets a read-only 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 read-only collection of messages found in the pinned messages.
- </returns>
- </member>
- <member name="T:Discord.WebSocket.ISocketPrivateChannel">
- <summary>
- Represents a generic WebSocket-based channel that is private to select recipients.
- </summary>
- </member>
- <member name="T:Discord.WebSocket.SocketCategoryChannel">
- <summary>
- Represents a WebSocket-based category channel.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketCategoryChannel.Users">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketCategoryChannel.Channels">
- <summary>
- Gets the child channels of this category.
- </summary>
- <returns>
- A read-only collection of <see cref="T:Discord.WebSocket.SocketGuildChannel" /> whose
- <see cref="P:Discord.INestedChannel.CategoryId" /> matches the snowflake identifier of this category
- channel.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketCategoryChannel.GetUser(System.UInt64)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketCategoryChannel.Discord#IGuildChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketCategoryChannel.Discord#IGuildChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketCategoryChannel.Discord#IChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketCategoryChannel.Discord#IChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="T:Discord.WebSocket.SocketChannel">
- <summary>
- Represents a WebSocket-based channel.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketChannel.CreatedAt">
- <summary>
- Gets when the channel is created.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketChannel.Users">
- <summary>
- Gets a collection of users from the WebSocket cache.
- </summary>
- </member>
- <member name="M:Discord.WebSocket.SocketChannel.CreatePrivate(Discord.WebSocket.DiscordSocketClient,Discord.WebSocket.ClientState,Discord.API.Channel)">
- <exception cref="T:System.InvalidOperationException">Unexpected channel type is created.</exception>
- </member>
- <member name="M:Discord.WebSocket.SocketChannel.GetUser(System.UInt64)">
- <summary>
- Gets a generic user from this channel.
- </summary>
- <param name="id">The snowflake identifier of the user.</param>
- <returns>
- A generic WebSocket-based user associated with the snowflake identifier.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketChannel.Discord#IChannel#Name">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketChannel.Discord#IChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketChannel.Discord#IChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketChannelHelper.AddMessage(Discord.WebSocket.ISocketMessageChannel,Discord.WebSocket.DiscordSocketClient,Discord.WebSocket.SocketMessage)">
- <exception cref="T:System.NotSupportedException">Unexpected <see cref="T:Discord.WebSocket.ISocketMessageChannel"/> type.</exception>
- </member>
- <member name="M:Discord.WebSocket.SocketChannelHelper.RemoveMessage(Discord.WebSocket.ISocketMessageChannel,Discord.WebSocket.DiscordSocketClient,System.UInt64)">
- <exception cref="T:System.NotSupportedException">Unexpected <see cref="T:Discord.WebSocket.ISocketMessageChannel"/> type.</exception>
- </member>
- <member name="T:Discord.WebSocket.SocketDMChannel">
- <summary>
- Represents a WebSocket-based direct-message channel.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketDMChannel.Recipient">
- <summary>
- Gets the recipient of the channel.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketDMChannel.CachedMessages">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketDMChannel.Users">
- <summary>
- Gets a collection that is the current logged-in user and the recipient.
- </summary>
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.CloseAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.GetCachedMessage(System.UInt64)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.GetMessageAsync(System.UInt64,Discord.RequestOptions)">
- <summary>
- Gets the message associated with the given <paramref name="id"/>.
- </summary>
- <param name="id">TThe ID of the message.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- The message gotten from either the cache or the download, or <c>null</c> if none is found.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.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.WebSocket.SocketDMChannel.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.WebSocket.SocketDMChannel.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.WebSocket.SocketDMChannel.GetCachedMessages(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.GetCachedMessages(System.UInt64,Discord.Direction,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.GetCachedMessages(Discord.IMessage,Discord.Direction,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.GetPinnedMessagesAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.SendMessageAsync(System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[],Discord.Embed[])">
- <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.WebSocket.SocketDMChannel.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.WebSocket.SocketDMChannel.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.WebSocket.SocketDMChannel.DeleteMessageAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.DeleteMessageAsync(Discord.IMessage,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.ModifyMessageAsync(System.UInt64,System.Action{Discord.MessageProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.TriggerTypingAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.EnterTypingState(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.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.WebSocket.SocketUser"/> object that is a recipient of this channel; otherwise <c>null</c>.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.ToString">
- <summary>
- Returns the recipient user.
- </summary>
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.GetUsersInternal">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.GetUserInternal(System.UInt64)">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketDMChannel.Discord#IDMChannel#Recipient">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketDMChannel.Discord#WebSocket#ISocketPrivateChannel#Recipients">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketDMChannel.Discord#IPrivateChannel#Recipients">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#GetMessageAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#GetMessagesAsync(System.Int32,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#GetMessagesAsync(System.UInt64,Discord.Direction,System.Int32,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#GetMessagesAsync(Discord.IMessage,Discord.Direction,System.Int32,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#GetPinnedMessagesAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.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.WebSocket.SocketDMChannel.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.WebSocket.SocketDMChannel.Discord#IMessageChannel#SendMessageAsync(System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[],Discord.Embed[])">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketDMChannel.Discord#IChannel#Name">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.Discord#IChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketDMChannel.Discord#IChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="T:Discord.WebSocket.SocketGroupChannel">
- <summary>
- Represents a WebSocket-based private group channel.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketGroupChannel.Name">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGroupChannel.CachedMessages">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGroupChannel.Users">
- <summary>
- Returns a collection representing all of the users in the group.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketGroupChannel.Recipients">
- <summary>
- Returns a collection representing all users in the group, not including the client.
- </summary>
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.LeaveAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.ConnectAsync">
- <exception cref="T:System.NotSupportedException">Voice is not yet supported for group channels.</exception>
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.GetCachedMessage(System.UInt64)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.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.WebSocket.SocketGroupChannel.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.WebSocket.SocketGroupChannel.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.WebSocket.SocketGroupChannel.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.WebSocket.SocketGroupChannel.GetCachedMessages(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.GetCachedMessages(System.UInt64,Discord.Direction,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.GetCachedMessages(Discord.IMessage,Discord.Direction,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.GetPinnedMessagesAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.SendMessageAsync(System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[],Discord.Embed[])">
- <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.WebSocket.SocketGroupChannel.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.WebSocket.SocketGroupChannel.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.WebSocket.SocketGroupChannel.DeleteMessageAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.DeleteMessageAsync(Discord.IMessage,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.ModifyMessageAsync(System.UInt64,System.Action{Discord.MessageProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.TriggerTypingAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.EnterTypingState(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.GetUser(System.UInt64)">
- <summary>
- Gets a user from this group.
- </summary>
- <param name="id">The snowflake identifier of the user.</param>
- <returns>
- A WebSocket-based group user associated with the snowflake identifier.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.ToString">
- <summary>
- Returns the name of the group.
- </summary>
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.GetUsersInternal">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.GetUserInternal(System.UInt64)">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGroupChannel.Discord#WebSocket#ISocketPrivateChannel#Recipients">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGroupChannel.Discord#IPrivateChannel#Recipients">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.Discord#IMessageChannel#GetMessageAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.Discord#IMessageChannel#GetMessagesAsync(System.Int32,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.Discord#IMessageChannel#GetMessagesAsync(System.UInt64,Discord.Direction,System.Int32,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.Discord#IMessageChannel#GetMessagesAsync(Discord.IMessage,Discord.Direction,System.Int32,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.Discord#IMessageChannel#GetPinnedMessagesAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.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.WebSocket.SocketGroupChannel.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.WebSocket.SocketGroupChannel.Discord#IMessageChannel#SendMessageAsync(System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[],Discord.Embed[])">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.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="M:Discord.WebSocket.SocketGroupChannel.Discord#IChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGroupChannel.Discord#IChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="T:Discord.WebSocket.SocketGuildChannel">
- <summary>
- Represents a WebSocket-based guild channel.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketGuildChannel.Guild">
- <summary>
- Gets the guild associated with this channel.
- </summary>
- <returns>
- A guild object that this channel belongs to.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketGuildChannel.Name">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildChannel.Position">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildChannel.PermissionOverwrites">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildChannel.Users">
- <summary>
- Gets a collection of users that are able to view the channel.
- </summary>
- <returns>
- A read-only collection of users that can access the channel (i.e. the users seen in the user list).
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketGuildChannel.Update(Discord.WebSocket.ClientState,Discord.API.Channel)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildChannel.ModifyAsync(System.Action{Discord.GuildChannelProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildChannel.DeleteAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildChannel.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.WebSocket.SocketGuildChannel.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.WebSocket.SocketGuildChannel.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.WebSocket.SocketGuildChannel.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.WebSocket.SocketGuildChannel.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.WebSocket.SocketGuildChannel.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.WebSocket.SocketGuildChannel.ToString">
- <summary>
- Gets the name of the channel.
- </summary>
- <returns>
- A string that resolves to <see cref="P:Discord.WebSocket.SocketGuildChannel.Name"/>.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketGuildChannel.GetUsersInternal">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildChannel.GetUserInternal(System.UInt64)">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#Guild">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#GuildId">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#GetPermissionOverwrite(Discord.IRole)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#GetPermissionOverwrite(Discord.IUser)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#AddPermissionOverwriteAsync(Discord.IRole,Discord.OverwritePermissions,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#AddPermissionOverwriteAsync(Discord.IUser,Discord.OverwritePermissions,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#RemovePermissionOverwriteAsync(Discord.IRole,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#RemovePermissionOverwriteAsync(Discord.IUser,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildChannel.Discord#IChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildChannel.Discord#IChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="T:Discord.WebSocket.SocketNewsChannel">
- <summary>
- Represents a WebSocket-based news channel in a guild that has the same properties as a <see cref="T:Discord.WebSocket.SocketTextChannel"/>.
- </summary>
- <remarks>
- <note type="warning">
- The <see cref="P:Discord.WebSocket.SocketNewsChannel.SlowModeInterval"/> property is not supported for news channels.
- </note>
- </remarks>
- </member>
- <member name="P:Discord.WebSocket.SocketNewsChannel.SlowModeInterval">
- <inheritdoc />
- <remarks>
- <note type="important">
- This property is not supported by this type. Attempting to use this property will result in a <see cref="T:System.NotSupportedException"/>.
- </note>
- </remarks>
- </member>
- <member name="T:Discord.WebSocket.SocketStageChannel">
- <summary>
- Represents a stage channel recieved over the gateway.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketStageChannel.Topic">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketStageChannel.PrivacyLevel">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketStageChannel.DiscoverableDisabled">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketStageChannel.Live">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketStageChannel.IsSpeaker">
- <summary>
- Returns <see langword="true"/> if the current user is a speaker within the stage, otherwise <see langword="false"/>.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketStageChannel.Speakers">
- <summary>
- Gets a collection of users who are speakers within the stage.
- </summary>
- </member>
- <member name="M:Discord.WebSocket.SocketStageChannel.StartStageAsync(System.String,Discord.StagePrivacyLevel,Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketStageChannel.ModifyInstanceAsync(System.Action{Discord.StageInstanceProperties},Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketStageChannel.StopStageAsync(Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketStageChannel.RequestToSpeakAsync(Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketStageChannel.BecomeSpeakerAsync(Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketStageChannel.StopSpeakingAsync(Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketStageChannel.MoveToSpeakerAsync(Discord.IGuildUser,Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketStageChannel.RemoveFromSpeakerAsync(Discord.IGuildUser,Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="T:Discord.WebSocket.SocketTextChannel">
- <summary>
- Represents a WebSocket-based channel in a guild that can send and receive messages.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketTextChannel.Topic">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketTextChannel.SlowModeInterval">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketTextChannel.CategoryId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketTextChannel.Category">
- <summary>
- Gets the parent (category) of this channel in the guild's channel list.
- </summary>
- <returns>
- An <see cref="T:Discord.ICategoryChannel"/> representing the parent of this channel; <c>null</c> if none is set.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.SyncPermissionsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketTextChannel.IsNsfw">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketTextChannel.Mention">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketTextChannel.CachedMessages">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketTextChannel.Users">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketTextChannel.Threads">
- <summary>
- Gets a collection of threads within this text channel.
- </summary>
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.ModifyAsync(System.Action{Discord.TextChannelProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.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.WebSocket.SocketTextChannel.GetCachedMessage(System.UInt64)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.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.WebSocket.SocketTextChannel.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.WebSocket.SocketTextChannel.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.WebSocket.SocketTextChannel.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.WebSocket.SocketTextChannel.GetCachedMessages(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.GetCachedMessages(System.UInt64,Discord.Direction,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.GetCachedMessages(Discord.IMessage,Discord.Direction,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.GetPinnedMessagesAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.SendMessageAsync(System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[],Discord.Embed[])">
- <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.WebSocket.SocketTextChannel.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.WebSocket.SocketTextChannel.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.WebSocket.SocketTextChannel.DeleteMessagesAsync(System.Collections.Generic.IEnumerable{Discord.IMessage},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.DeleteMessagesAsync(System.Collections.Generic.IEnumerable{System.UInt64},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.ModifyMessageAsync(System.UInt64,System.Action{Discord.MessageProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.DeleteMessageAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.DeleteMessageAsync(Discord.IMessage,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.TriggerTypingAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.EnterTypingState(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.GetUser(System.UInt64)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.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.WebSocket.SocketTextChannel.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.WebSocket.SocketTextChannel.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.WebSocket.SocketTextChannel.CreateInviteAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.CreateInviteToApplicationAsync(System.UInt64,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.CreateInviteToStreamAsync(Discord.IUser,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.GetInvitesAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.Discord#ITextChannel#CreateWebhookAsync(System.String,System.IO.Stream,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.Discord#ITextChannel#GetWebhookAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.Discord#ITextChannel#GetWebhooksAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.Discord#ITextChannel#CreateThreadAsync(System.String,Discord.ThreadType,Discord.ThreadArchiveDuration,Discord.IMessage,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.Discord#IGuildChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.Discord#IGuildChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.Discord#IMessageChannel#GetMessageAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.Discord#IMessageChannel#GetMessagesAsync(System.Int32,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.Discord#IMessageChannel#GetMessagesAsync(System.UInt64,Discord.Direction,System.Int32,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.Discord#IMessageChannel#GetMessagesAsync(Discord.IMessage,Discord.Direction,System.Int32,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.Discord#IMessageChannel#GetPinnedMessagesAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.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.WebSocket.SocketTextChannel.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.WebSocket.SocketTextChannel.Discord#IMessageChannel#SendMessageAsync(System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.ISticker[],Discord.Embed[])">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketTextChannel.Discord#INestedChannel#GetCategoryAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="T:Discord.WebSocket.SocketThreadChannel">
- <summary>
- Represents a thread channel inside of a guild.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadChannel.Type">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadChannel.Owner">
- <summary>
- Gets the owner of the current thread.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadChannel.CurrentUser">
- <summary>
- Gets the current users within this thread.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadChannel.Joined">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadChannel.IsPrivateThread">
- <summary>
- <see langword="true"/> if this thread is private, otherwise <see langword="false"/>
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadChannel.ParentChannel">
- <summary>
- Gets the parent channel this thread resides in.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadChannel.MessageCount">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadChannel.MemberCount">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadChannel.Archived">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadChannel.ArchiveTimestamp">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadChannel.AutoArchiveDuration">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadChannel.Locked">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadChannel.Users">
- <summary>
- Gets a collection of cached users within this thread.
- </summary>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadChannel.GetUser(System.UInt64)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketThreadChannel.GetUsersAsync(Discord.RequestOptions)">
- <summary>
- Gets all users inside this thread.
- </summary>
- <remarks>
- If all users are not downloaded then this method will call <see cref="M:Discord.WebSocket.SocketThreadChannel.DownloadUsersAsync(Discord.RequestOptions)"/> and return the result.
- </remarks>
- <param name="options">The options to be used when sending the request.</param>
- <returns>A task representing the download operation.</returns>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadChannel.DownloadUsersAsync(Discord.RequestOptions)">
- <summary>
- Downloads all users that have access to this thread.
- </summary>
- <param name="options">The options to be used when sending the request.</param>
- <returns>A task representing the asyncronous download operation.</returns>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadChannel.JoinAsync(Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadChannel.LeaveAsync(Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadChannel.AddUserAsync(Discord.IGuildUser,Discord.RequestOptions)">
- <summary>
- Adds a user to this thread.
- </summary>
- <param name="user">The <see cref="T:Discord.IGuildUser"/> to add.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous operation of adding a member to a thread.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadChannel.RemoveUserAsync(Discord.IGuildUser,Discord.RequestOptions)">
- <summary>
- Removes a user from this thread.
- </summary>
- <param name="user">The <see cref="T:Discord.IGuildUser"/> to remove from this thread.</param>
- <param name="options">The options to be used when sending the request.</param>
- <returns>
- A task that represents the asynchronous operation of removing a user from this thread.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadChannel.AddPermissionOverwriteAsync(Discord.IRole,Discord.OverwritePermissions,Discord.RequestOptions)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadChannel.AddPermissionOverwriteAsync(Discord.IUser,Discord.OverwritePermissions,Discord.RequestOptions)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadChannel.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.WebSocket.SocketThreadChannel.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.WebSocket.SocketThreadChannel.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.WebSocket.SocketThreadChannel.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.WebSocket.SocketThreadChannel.GetInvitesAsync(Discord.RequestOptions)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadChannel.GetPermissionOverwrite(Discord.IRole)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadChannel.GetPermissionOverwrite(Discord.IUser)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadChannel.GetWebhookAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadChannel.GetWebhooksAsync(Discord.RequestOptions)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadChannel.ModifyAsync(System.Action{Discord.TextChannelProperties},Discord.RequestOptions)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadChannel.RemovePermissionOverwriteAsync(Discord.IRole,Discord.RequestOptions)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadChannel.RemovePermissionOverwriteAsync(Discord.IUser,Discord.RequestOptions)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadChannel.PermissionOverwrites">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadChannel.SyncPermissionsAsync(Discord.RequestOptions)">
- <inheritdoc/>
- <remarks>
- <b>This method is not supported in threads.</b>
- </remarks>
- </member>
- <member name="T:Discord.WebSocket.SocketVoiceChannel">
- <summary>
- Represents a WebSocket-based voice channel in a guild.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketVoiceChannel.Bitrate">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketVoiceChannel.UserLimit">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketVoiceChannel.CategoryId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketVoiceChannel.Category">
- <summary>
- Gets the parent (category) channel of this channel.
- </summary>
- <returns>
- A category channel representing the parent of this channel; <c>null</c> if none is set.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketVoiceChannel.Mention">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketVoiceChannel.SyncPermissionsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketVoiceChannel.Users">
- <summary>
- Gets a collection of users that are currently connected to this voice channel.
- </summary>
- <returns>
- A read-only collection of users that are currently connected to this voice channel.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketVoiceChannel.Update(Discord.WebSocket.ClientState,Discord.API.Channel)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketVoiceChannel.ModifyAsync(System.Action{Discord.VoiceChannelProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketVoiceChannel.ConnectAsync(System.Boolean,System.Boolean,System.Boolean)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketVoiceChannel.DisconnectAsync">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketVoiceChannel.GetUser(System.UInt64)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketVoiceChannel.CreateInviteAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketVoiceChannel.CreateInviteToApplicationAsync(System.UInt64,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketVoiceChannel.CreateInviteToStreamAsync(Discord.IUser,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketVoiceChannel.GetInvitesAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketVoiceChannel.Discord#IGuildChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketVoiceChannel.Discord#IGuildChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketVoiceChannel.Discord#INestedChannel#GetCategoryAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="T:Discord.WebSocket.SocketGuild">
- <summary>
- Represents a WebSocket-based guild object.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.Name">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.AFKTimeout">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.IsWidgetEnabled">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.VerificationLevel">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.MfaLevel">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.DefaultMessageNotifications">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.ExplicitContentFilter">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.MemberCount">
- <summary>
- Gets the number of members.
- </summary>
- <remarks>
- This property retrieves the number of members returned by Discord.
- <note type="tip">
- <para>
- Due to how this property is returned by Discord instead of relying on the WebSocket cache, the
- number here is the most accurate in terms of counting the number of users within this guild.
- </para>
- <para>
- Use this instead of enumerating the count of the
- <see cref="P:Discord.WebSocket.SocketGuild.Users" /> collection, as you may see discrepancy
- between that and this property.
- </para>
- </note>
- </remarks>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.DownloadedMemberCount">
- <summary> Gets the number of members downloaded to the local guild cache. </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.IsConnected">
- <summary> Indicates whether the client is connected to this guild. </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.ApplicationId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.OwnerId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.Owner">
- <summary> Gets the user that owns this guild. </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.VoiceRegionId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.IconId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.SplashId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.DiscoverySplashId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.PremiumTier">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.BannerId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.VanityURLCode">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.SystemChannelFlags">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.Description">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.PremiumSubscriptionCount">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.PreferredLocale">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.MaxPresences">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.MaxMembers">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.MaxVideoChannelUsers">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.NsfwLevel">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.PreferredCulture">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.CreatedAt">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.IconUrl">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.SplashUrl">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.DiscoverySplashUrl">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.BannerUrl">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.HasAllMembers">
- <summary> Indicates whether the client has all the members downloaded to the local guild cache. </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.IsSynced">
- <summary> Indicates whether the guild cache is synced to this guild. </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.AudioClient">
- <summary>
- Gets the <see cref="T:Discord.Audio.IAudioClient" /> associated with this guild.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.DefaultChannel">
- <summary>
- Gets the default channel in this guild.
- </summary>
- <remarks>
- This property retrieves the first viewable text channel for this guild.
- <note type="warning">
- This channel does not guarantee the user can send message to it, as it only looks for the first viewable
- text channel.
- </note>
- </remarks>
- <returns>
- A <see cref="T:Discord.WebSocket.SocketTextChannel"/> representing the first viewable channel that the user has access to.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.AFKChannel">
- <summary>
- Gets the AFK voice channel in this guild.
- </summary>
- <returns>
- A <see cref="T:Discord.WebSocket.SocketVoiceChannel" /> 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="P:Discord.WebSocket.SocketGuild.MaxBitrate">
- <summary>
- Gets the max bitrate for voice channels in this guild.
- </summary>
- <returns>
- A <see cref="T:System.Int32"/> representing the maximum bitrate value allowed by Discord in this guild.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.WidgetChannel">
- <summary>
- Gets the widget channel (i.e. the channel set in the guild's widget settings) in this guild.
- </summary>
- <returns>
- A channel set within the server's widget settings; <see langword="null"/> if none is set.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.SystemChannel">
- <summary>
- Gets the system channel where randomized welcome messages are sent in this guild.
- </summary>
- <returns>
- A text channel where randomized welcome messages will be sent to; <see langword="null"/> if none is set.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.RulesChannel">
- <summary>
- Gets the channel with the guild rules.
- </summary>
- <returns>
- A text channel with the guild rules; <see langword="null"/> if none is set.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.PublicUpdatesChannel">
- <summary>
- Gets the channel where admins and moderators of Community guilds receive
- notices from Discord.
- </summary>
- <returns>
- A text channel where admins and moderators of Community guilds receive
- notices from Discord; <see langword="null"/> if none is set.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.TextChannels">
- <summary>
- Gets a collection of all text channels in this guild.
- </summary>
- <returns>
- A read-only collection of message channels found within this guild.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.VoiceChannels">
- <summary>
- Gets a collection of all voice channels in this guild.
- </summary>
- <returns>
- A read-only collection of voice channels found within this guild.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.StageChannels">
- <summary>
- Gets a collection of all stage channels in this guild.
- </summary>
- <returns>
- A read-only collection of stage channels found within this guild.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.CategoryChannels">
- <summary>
- Gets a collection of all category channels in this guild.
- </summary>
- <returns>
- A read-only collection of category channels found within this guild.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.ThreadChannels">
- <summary>
- Gets a collection of all thread channels in this guild.
- </summary>
- <returns>
- A read-only collection of thread channels found within this guild.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.CurrentUser">
- <summary>
- Gets the current logged-in user.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.EveryoneRole">
- <summary>
- Gets the built-in role containing all users in this guild.
- </summary>
- <returns>
- A role object that represents an <c>@everyone</c> role in this guild.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.Channels">
- <summary>
- Gets a collection of all channels in this guild.
- </summary>
- <returns>
- A read-only collection of generic channels found within this guild.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.Emotes">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.Stickers">
- <summary>
- Gets a collection of all custom stickers for this guild.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.Features">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.Users">
- <summary>
- Gets a collection of users in this guild.
- </summary>
- <remarks>
- This property retrieves all users found within this guild.
- <note type="warning">
- <para>
- This property may not always return all the members for large guilds (i.e. guilds containing
- 100+ users). If you are simply looking to get the number of users present in this guild,
- consider using <see cref="P:Discord.WebSocket.SocketGuild.MemberCount"/> instead.
- </para>
- <para>
- Otherwise, you may need to enable <see cref="P:Discord.WebSocket.DiscordSocketConfig.AlwaysDownloadUsers"/> to fetch
- the full user list upon startup, or use <see cref="M:Discord.WebSocket.SocketGuild.DownloadUsersAsync"/> to manually download
- the users.
- </para>
- </note>
- </remarks>
- <returns>
- A collection of guild users found within this guild.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.Roles">
- <summary>
- Gets a collection of all roles in this guild.
- </summary>
- <returns>
- A read-only collection of roles found within this guild.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.DeleteAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.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.WebSocket.SocketGuild.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.WebSocket.SocketGuild.ReorderChannelsAsync(System.Collections.Generic.IEnumerable{Discord.ReorderChannelProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.ReorderRolesAsync(System.Collections.Generic.IEnumerable{Discord.ReorderRoleProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.LeaveAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.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.WebSocket.SocketGuild.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.WebSocket.SocketGuild.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.WebSocket.SocketGuild.AddBanAsync(Discord.IUser,System.Int32,System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.AddBanAsync(System.UInt64,System.Int32,System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.RemoveBanAsync(Discord.IUser,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.RemoveBanAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.GetChannel(System.UInt64)">
- <summary>
- Gets a channel in this guild.
- </summary>
- <param name="id">The snowflake identifier for the channel.</param>
- <returns>
- A generic channel associated with the specified <paramref name="id" />; <see langword="null"/> if none is found.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.GetTextChannel(System.UInt64)">
- <summary>
- Gets a text channel in this guild.
- </summary>
- <param name="id">The snowflake identifier for the text channel.</param>
- <returns>
- A text channel associated with the specified <paramref name="id" />; <see langword="null"/> if none is found.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.GetThreadChannel(System.UInt64)">
- <summary>
- Gets a thread in this guild.
- </summary>
- <param name="id">The snowflake identifier for the thread.</param>
- <returns>
- A thread channel associated with the specified <paramref name="id" />; <see langword="null"/> if none is found.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.GetVoiceChannel(System.UInt64)">
- <summary>
- Gets a voice channel in this guild.
- </summary>
- <param name="id">The snowflake identifier for the voice channel.</param>
- <returns>
- A voice channel associated with the specified <paramref name="id" />; <see langword="null"/> if none is found.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.GetStageChannel(System.UInt64)">
- <summary>
- Gets a stage channel in this guild.
- </summary>
- <param name="id">The snowflake identifier for the stage channel.</param>
- <returns>
- A stage channel associated with the specified <paramref name="id" />; <see langword="null"/> if none is found.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.GetCategoryChannel(System.UInt64)">
- <summary>
- Gets a category channel in this guild.
- </summary>
- <param name="id">The snowflake identifier for the category channel.</param>
- <returns>
- A category channel associated with the specified <paramref name="id" />; <see langword="null"/> if none is found.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.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.WebSocket.SocketGuild.CreateVoiceChannelAsync(System.String,System.Action{Discord.VoiceChannelProperties},Discord.RequestOptions)">
- <summary>
- Creates a new voice channel in this guild.
- </summary>
- <param name="name">The new name for the voice 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>
- A task that represents the asynchronous creation operation. The task result contains the newly created
- voice channel.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.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.WebSocket.SocketGuild.CreateCategoryChannelAsync(System.String,System.Action{Discord.GuildChannelProperties},Discord.RequestOptions)">
- <summary>
- Creates a new channel category in this guild.
- </summary>
- <param name="name">The new name for the category.</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>
- A task that represents the asynchronous creation operation. The task result contains the newly created
- category channel.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.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.WebSocket.SocketGuild.DeleteApplicationCommandsAsync(Discord.RequestOptions)">
- <summary>
- Deletes all application 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.WebSocket.SocketGuild.GetApplicationCommandsAsync(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.WebSocket.SocketGuild.GetApplicationCommandAsync(System.UInt64,Discord.CacheMode,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="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 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.WebSocket.SocketGuild.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.WebSocket.SocketGuild.BulkOverwriteApplicationCommandAsync(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.WebSocket.SocketGuild.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.WebSocket.SocketGuild.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 task that represents the asynchronous get operation. The task result contains the partial metadata of
- the vanity invite found within this guild; <see langword="null"/> if none is found.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.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.WebSocket.SocketGuild.CreateRoleAsync(System.String,System.Nullable{Discord.GuildPermissions},System.Nullable{Discord.Color},System.Boolean,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.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="isMentionable">Whether the role can be mentioned.</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>
- A task that represents the asynchronous creation operation. The task result contains the newly created
- role.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.AddGuildUserAsync(System.UInt64,System.String,System.Action{Discord.AddGuildUserProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.GetUser(System.UInt64)">
- <summary>
- Gets a user from this guild.
- </summary>
- <remarks>
- This method retrieves a user found within this guild.
- <note>
- This may return <see langword="null"/> in the WebSocket implementation due to incomplete user collection in
- large guilds.
- </note>
- </remarks>
- <param name="id">The snowflake identifier of the user.</param>
- <returns>
- A guild user associated with the specified <paramref name="id"/>; <see langword="null"/> if none is found.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.PruneUsersAsync(System.Int32,System.Boolean,Discord.RequestOptions,System.Collections.Generic.IEnumerable{System.UInt64})">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.GetUsersAsync(Discord.RequestOptions)">
- <summary>
- Gets a collection of all users in this guild.
- </summary>
- <remarks>
- <para>This method retrieves all users found within this guild throught REST.</para>
- <para>Users returned by this method are not cached.</para>
- </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.WebSocket.SocketGuild.DownloadUsersAsync">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.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.WebSocket.SocketGuild.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 filter 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.WebSocket.SocketGuild.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.WebSocket.SocketGuild.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.WebSocket.SocketGuild.GetEmotesAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.GetEmoteAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.CreateEmoteAsync(System.String,Discord.Image,Discord.Optional{System.Collections.Generic.IEnumerable{Discord.IRole}},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.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.WebSocket.SocketGuild.DeleteEmoteAsync(Discord.GuildEmote,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.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.WebSocket.SocketGuild.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.WebSocket.SocketGuild.GetStickerAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <summary>
- Gets a specific sticker within this guild.
- </summary>
- <param name="id">The id of the sticker to get.</param>
- <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 the sticker found with the
- specified <paramref name="id"/>; <see langword="null" /> if none is found.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.GetSticker(System.UInt64)">
- <summary>
- Gets a specific sticker within this guild.
- </summary>
- <param name="id">The id of the sticker to get.</param>
- <returns>A sticker, if none is found then <see langword="null"/>.</returns>
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.GetStickersAsync(Discord.CacheMode,Discord.RequestOptions)">
- <summary>
- Gets a collection of all stickers within 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 stickers found within the guild.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.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.WebSocket.SocketGuild.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.WebSocket.SocketGuild.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.WebSocket.SocketGuild.DeleteStickerAsync(Discord.WebSocket.SocketCustomSticker,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="M:Discord.WebSocket.SocketGuild.ToString">
- <summary>
- Gets the name of the guild.
- </summary>
- <returns>
- A string that resolves to <see cref="P:Discord.WebSocket.SocketGuild.Name"/>.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.Discord#IGuild#AFKChannelId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.Discord#IGuild#AudioClient">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.Discord#IGuild#Available">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.Discord#IGuild#WidgetChannelId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.Discord#IGuild#SystemChannelId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.Discord#IGuild#RulesChannelId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.Discord#IGuild#PublicUpdatesChannelId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.Discord#IGuild#EveryoneRole">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.Discord#IGuild#Roles">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.Discord#IGuild#ApproximateMemberCount">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.Discord#IGuild#ApproximatePresenceCount">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuild.Discord#IGuild#Stickers">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetBansAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetBanAsync(Discord.IUser,Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetBanAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetTextChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetTextChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetThreadChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetThreadChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetVoiceChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetCategoriesAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetVoiceChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetStageChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetStageChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetAFKChannelAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetDefaultChannelAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetWidgetChannelAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetSystemChannelAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetRulesChannelAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetPublicUpdatesChannelAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#CreateTextChannelAsync(System.String,System.Action{Discord.TextChannelProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#CreateVoiceChannelAsync(System.String,System.Action{Discord.VoiceChannelProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#CreateStageChannelAsync(System.String,System.Action{Discord.VoiceChannelProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#CreateCategoryAsync(System.String,System.Action{Discord.GuildChannelProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetVoiceRegionsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetIntegrationsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#CreateIntegrationAsync(System.UInt64,System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetInvitesAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetVanityInviteAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetRole(System.UInt64)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#CreateRoleAsync(System.String,System.Nullable{Discord.GuildPermissions},System.Nullable{Discord.Color},System.Boolean,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.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.WebSocket.SocketGuild.Discord#IGuild#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#AddGuildUserAsync(System.UInt64,System.String,System.Action{Discord.AddGuildUserProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetCurrentUserAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetOwnerAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#SearchUsersAsync(System.String,System.Int32,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetAuditLogsAsync(System.Int32,Discord.CacheMode,Discord.RequestOptions,System.Nullable{System.UInt64},System.Nullable{System.UInt64},System.Nullable{Discord.ActionType})">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetWebhookAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetWebhooksAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetApplicationCommandsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#CreateStickerAsync(System.String,System.String,System.Collections.Generic.IEnumerable{System.String},Discord.Image,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.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.WebSocket.SocketGuild.Discord#IGuild#CreateStickerAsync(System.String,System.String,System.Collections.Generic.IEnumerable{System.String},System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetStickerAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetStickersAsync(Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#DeleteStickerAsync(Discord.ICustomSticker,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#GetApplicationCommandAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#CreateApplicationCommandAsync(Discord.ApplicationCommandProperties,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuild.Discord#IGuild#BulkOverwriteApplicationCommandsAsync(Discord.ApplicationCommandProperties[],Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="T:Discord.WebSocket.SocketMessageCommand">
- <summary>
- Represents a Websocket-based slash command received over the gateway.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketMessageCommand.Data">
- <summary>
- The data associated with this interaction.
- </summary>
- </member>
- <member name="T:Discord.WebSocket.SocketMessageCommandData">
- <summary>
- Represents the data tied with the <see cref="T:Discord.WebSocket.SocketMessageCommand"/> interaction.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketMessageCommandData.Message">
- <summary>
- Gets the messagte associated with this message command.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketMessageCommandData.Options">
- <inheritdoc/>
- <remarks>
- <b>Note</b> Not implemented for <see cref="T:Discord.WebSocket.SocketMessageCommandData"/>
- </remarks>
- </member>
- <member name="T:Discord.WebSocket.SocketUserCommand">
- <summary>
- Represents a Websocket-based slash command received over the gateway.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketUserCommand.Data">
- <summary>
- The data associated with this interaction.
- </summary>
- </member>
- <member name="T:Discord.WebSocket.SocketUserCommandData">
- <summary>
- Represents the data tied with the <see cref="T:Discord.WebSocket.SocketUserCommand"/> interaction.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketUserCommandData.Member">
- <summary>
- Gets the user who this command targets.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketUserCommandData.Options">
- <inheritdoc/>
- <remarks>
- <b>Note</b> Not implemented for <see cref="T:Discord.WebSocket.SocketUserCommandData"/>
- </remarks>
- </member>
- <member name="T:Discord.WebSocket.SocketMessageComponent">
- <summary>
- Represents a Websocket-based interaction type for Message Components.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketMessageComponent.Data">
- <summary>
- The data received with this interaction, contains the button that was clicked.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketMessageComponent.Message">
- <summary>
- The message that contained the trigger for this interaction.
- </summary>
- </member>
- <member name="M:Discord.WebSocket.SocketMessageComponent.RespondAsync(System.String,Discord.Embed[],System.Boolean,System.Boolean,Discord.AllowedMentions,Discord.RequestOptions,Discord.MessageComponent,Discord.Embed)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketMessageComponent.UpdateAsync(System.Action{Discord.MessageProperties},Discord.RequestOptions)">
- <summary>
- Updates the message which this component resides in with the type <see cref="F:Discord.InteractionResponseType.UpdateMessage"/>
- </summary>
- <param name="func">A delegate containing the properties to modify the message with.</param>
- <param name="options">The request options for this async request.</param>
- <returns>A task that represents the asynchronous operation of updating the message.</returns>
- </member>
- <member name="M:Discord.WebSocket.SocketMessageComponent.FollowupAsync(System.String,Discord.Embed[],System.Boolean,System.Boolean,Discord.AllowedMentions,Discord.RequestOptions,Discord.MessageComponent,Discord.Embed)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketMessageComponent.FollowupWithFileAsync(System.String,System.IO.Stream,System.String,Discord.Embed[],System.Boolean,System.Boolean,Discord.AllowedMentions,Discord.RequestOptions,Discord.MessageComponent,Discord.Embed)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketMessageComponent.FollowupWithFileAsync(System.String,System.String,System.String,Discord.Embed[],System.Boolean,System.Boolean,Discord.AllowedMentions,Discord.RequestOptions,Discord.MessageComponent,Discord.Embed)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketMessageComponent.DeferLoadingAsync(System.Boolean,Discord.RequestOptions)">
- <summary>
- Defers an interaction and responds with type 5 (<see cref="F:Discord.InteractionResponseType.DeferredChannelMessageWithSource"/>)
- </summary>
- <param name="ephemeral"><see langword="true"/> to send this message ephemerally, otherwise <see langword="false"/>.</param>
- <param name="options">The request options for this async request.</param>
- <returns>
- A task that represents the asynchronous operation of acknowledging the interaction.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketMessageComponent.DeferAsync(System.Boolean,Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="T:Discord.WebSocket.SocketMessageComponentData">
- <summary>
- Represents the data sent with a <see cref="F:Discord.InteractionType.MessageComponent"/>.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketMessageComponentData.CustomId">
- <summary>
- The components Custom Id that was clicked
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketMessageComponentData.Type">
- <summary>
- The type of the component clicked
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketMessageComponentData.Values">
- <summary>
- The value(s) of a <see cref="T:Discord.SelectMenuComponent"/> interaction response.
- </summary>
- </member>
- <member name="T:Discord.WebSocket.SocketAutocompleteInteraction">
- <summary>
- Represents a <see cref="F:Discord.InteractionType.ApplicationCommandAutocomplete"/> received over the gateway.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketAutocompleteInteraction.Data">
- <summary>
- The autocomplete data of this interaction.
- </summary>
- </member>
- <member name="M:Discord.WebSocket.SocketAutocompleteInteraction.RespondAsync(System.Collections.Generic.IEnumerable{Discord.AutocompleteResult},Discord.RequestOptions)">
- <summary>
- Responds to this interaction with a set of choices.
- </summary>
- <param name="result">
- The set of choices for the user to pick from.
- <remarks>
- A max of 20 choices are allowed. Passing <see langword="null"/> for this argument will show the executing user that
- there is no choices for their autocompleted input.
- </remarks>
- </param>
- <param name="options">The request options for this response.</param>
- <returns>
- A task that represents the asynchronous operation of responding to this interaction.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketAutocompleteInteraction.RespondAsync(Discord.RequestOptions,Discord.AutocompleteResult[])">
- <summary>
- Responds to this interaction with a set of choices.
- </summary>
- <param name="options">The request options for this response.</param>
- <param name="result">
- The set of choices for the user to pick from.
- <remarks>
- A max of 20 choices are allowed. Passing <see langword="null"/> for this argument will show the executing user that
- there is no choices for their autocompleted input.
- </remarks>
- </param>
- <returns>
- A task that represents the asynchronous operation of responding to this interaction.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketAutocompleteInteraction.DeferAsync(System.Boolean,Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketAutocompleteInteraction.FollowupAsync(System.String,Discord.Embed[],System.Boolean,System.Boolean,Discord.AllowedMentions,Discord.RequestOptions,Discord.MessageComponent,Discord.Embed)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketAutocompleteInteraction.FollowupWithFileAsync(System.String,System.IO.Stream,System.String,Discord.Embed[],System.Boolean,System.Boolean,Discord.AllowedMentions,Discord.RequestOptions,Discord.MessageComponent,Discord.Embed)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketAutocompleteInteraction.FollowupWithFileAsync(System.String,System.String,System.String,Discord.Embed[],System.Boolean,System.Boolean,Discord.AllowedMentions,Discord.RequestOptions,Discord.MessageComponent,Discord.Embed)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketAutocompleteInteraction.RespondAsync(System.String,Discord.Embed[],System.Boolean,System.Boolean,Discord.AllowedMentions,Discord.RequestOptions,Discord.MessageComponent,Discord.Embed)">
- <inheritdoc/>
- </member>
- <member name="T:Discord.WebSocket.SocketAutocompleteInteractionData">
- <summary>
- Represents data for a slash commands autocomplete interaction.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketAutocompleteInteractionData.CommandName">
- <summary>
- Gets the name of the invoked command.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketAutocompleteInteractionData.CommandId">
- <summary>
- Gets the id of the invoked command.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketAutocompleteInteractionData.Type">
- <summary>
- Gets the type of the invoked command.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketAutocompleteInteractionData.Version">
- <summary>
- Gets the version of the invoked command.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketAutocompleteInteractionData.Current">
- <summary>
- Gets the current autocomplete option that is activly being filled out.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketAutocompleteInteractionData.Options">
- <summary>
- Gets a collection of all the other options the executing users has filled out.
- </summary>
- </member>
- <member name="T:Discord.WebSocket.SocketSlashCommand">
- <summary>
- Represents a Websocket-based slash command received over the gateway.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketSlashCommand.Data">
- <summary>
- The data associated with this interaction.
- </summary>
- </member>
- <member name="T:Discord.WebSocket.SocketSlashCommandData">
- <summary>
- Represents the data tied with the <see cref="T:Discord.WebSocket.SocketSlashCommand"/> interaction.
- </summary>
- </member>
- <member name="T:Discord.WebSocket.SocketSlashCommandDataOption">
- <summary>
- Represents a Websocket-based <see cref="T:Discord.IApplicationCommandInteractionDataOption"/> recieved by the gateway
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketSlashCommandDataOption.Name">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketSlashCommandDataOption.Value">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketSlashCommandDataOption.Type">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketSlashCommandDataOption.Options">
- <summary>
- The sub command options received for this sub command group.
- </summary>
- </member>
- <member name="T:Discord.WebSocket.SocketApplicationCommand">
- <summary>
- Represends a Websocket-based <see cref="T:Discord.IApplicationCommand"/>.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketApplicationCommand.IsGlobalCommand">
- <summary>
- <see langword="true"/> if this command is a global command, otherwise <see langword="false"/>.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketApplicationCommand.ApplicationId">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketApplicationCommand.Name">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketApplicationCommand.Type">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketApplicationCommand.Description">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketApplicationCommand.DefaultPermission">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketApplicationCommand.Options">
- <summary>
- A collection of <see cref="T:Discord.WebSocket.SocketApplicationCommandOption"/>'s for this command.
- </summary>
- <remarks>
- If the <see cref="P:Discord.WebSocket.SocketApplicationCommand.Type"/> is not a slash command, this field will be an empty collection.
- </remarks>
- </member>
- <member name="P:Discord.WebSocket.SocketApplicationCommand.CreatedAt">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketApplicationCommand.Guild">
- <summary>
- Returns the guild this command resides in, if this command is a global command then it will return <see langword="null"/>
- </summary>
- </member>
- <member name="M:Discord.WebSocket.SocketApplicationCommand.DeleteAsync(Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketApplicationCommand.ModifyAsync(System.Action{Discord.ApplicationCommandProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketApplicationCommand.ModifyAsync``1(System.Action{``0},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="T:Discord.WebSocket.SocketApplicationCommandChoice">
- <summary>
- Represents a choice for a <see cref="T:Discord.WebSocket.SocketApplicationCommandOption"/>.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketApplicationCommandChoice.Name">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketApplicationCommandChoice.Value">
- <inheritdoc/>
- </member>
- <member name="T:Discord.WebSocket.SocketApplicationCommandOption">
- <summary>
- Represents an option for a <see cref="T:Discord.WebSocket.SocketApplicationCommand"/>.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketApplicationCommandOption.Name">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketApplicationCommandOption.Type">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketApplicationCommandOption.Description">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketApplicationCommandOption.Default">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketApplicationCommandOption.Required">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketApplicationCommandOption.Choices">
- <summary>
- Choices for string and int types for the user to pick from.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketApplicationCommandOption.Options">
- <summary>
- If the option is a subcommand or subcommand group type, this nested options will be the parameters.
- </summary>
- </member>
- <member name="T:Discord.WebSocket.SocketCommandBase">
- <summary>
- Base class for User, Message, and Slash command interactions.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketCommandBase.CommandName">
- <summary>
- Gets the name of the invoked command.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketCommandBase.CommandId">
- <summary>
- Gets the id of the invoked command.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketCommandBase.Data">
- <summary>
- The data associated with this interaction.
- </summary>
- </member>
- <member name="M:Discord.WebSocket.SocketCommandBase.RespondAsync(System.String,Discord.Embed[],System.Boolean,System.Boolean,Discord.AllowedMentions,Discord.RequestOptions,Discord.MessageComponent,Discord.Embed)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketCommandBase.FollowupAsync(System.String,Discord.Embed[],System.Boolean,System.Boolean,Discord.AllowedMentions,Discord.RequestOptions,Discord.MessageComponent,Discord.Embed)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketCommandBase.FollowupWithFileAsync(System.String,System.IO.Stream,System.String,Discord.Embed[],System.Boolean,System.Boolean,Discord.AllowedMentions,Discord.RequestOptions,Discord.MessageComponent,Discord.Embed)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketCommandBase.FollowupWithFileAsync(System.String,System.String,System.String,Discord.Embed[],System.Boolean,System.Boolean,Discord.AllowedMentions,Discord.RequestOptions,Discord.MessageComponent,Discord.Embed)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketCommandBase.DeferAsync(System.Boolean,Discord.RequestOptions)">
- <summary>
- Acknowledges this interaction with the <see cref="F:Discord.InteractionResponseType.DeferredChannelMessageWithSource"/>.
- </summary>
- <returns>
- A task that represents the asynchronous operation of acknowledging the interaction.
- </returns>
- </member>
- <member name="T:Discord.WebSocket.SocketCommandBaseData`1">
- <summary>
- Represents the base data tied with the <see cref="T:Discord.WebSocket.SocketCommandBase"/> interaction.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketCommandBaseData`1.Name">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketCommandBaseData`1.Options">
- <summary>
- The <typeparamref name="TOption"/> received with this interaction.
- </summary>
- </member>
- <member name="T:Discord.WebSocket.SocketCommandBaseData">
- <summary>
- Represents the base data tied with the <see cref="T:Discord.WebSocket.SocketCommandBase"/> interaction.
- </summary>
- </member>
- <member name="T:Discord.WebSocket.SocketInteraction">
- <summary>
- Represents an Interaction recieved over the gateway.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketInteraction.Channel">
- <summary>
- The <see cref="T:Discord.WebSocket.ISocketMessageChannel"/> this interaction was used in.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketInteraction.User">
- <summary>
- The <see cref="T:Discord.WebSocket.SocketUser"/> who triggered this interaction.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketInteraction.Type">
- <summary>
- The type of this interaction.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketInteraction.Token">
- <summary>
- The token used to respond to this interaction.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketInteraction.Data">
- <summary>
- The data sent with this interaction.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketInteraction.Version">
- <summary>
- The version of this interaction.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketInteraction.CreatedAt">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketInteraction.IsValidToken">
- <summary>
- <see langword="true"/> if the token is valid for replying to, otherwise <see langword="false"/>.
- </summary>
- </member>
- <member name="M:Discord.WebSocket.SocketInteraction.RespondAsync(System.String,Discord.Embed[],System.Boolean,System.Boolean,Discord.AllowedMentions,Discord.RequestOptions,Discord.MessageComponent,Discord.Embed)">
- <summary>
- Responds to an Interaction with type <see cref="F:Discord.InteractionResponseType.ChannelMessageWithSource"/>.
- <para>
- If you have <see cref="!:DiscordSocketConfig.AlwaysAcknowledgeInteractions"/> set to <see langword="true"/>, You should use
- <see cref="M:Discord.WebSocket.SocketInteraction.FollowupAsync(System.String,Discord.Embed[],System.Boolean,System.Boolean,Discord.AllowedMentions,Discord.RequestOptions,Discord.MessageComponent,Discord.Embed)"/> instead.
- </para>
- </summary>
- <param name="text">The text of the message to be sent.</param>
- <param name="embeds">A array of embeds to send with this response. Max 10.</param>
- <param name="isTTS"><see langword="true"/> if the message should be read out by a text-to-speech reader, otherwise <see langword="false"/>.</param>
- <param name="ephemeral"><see langword="true"/> if the response should be hidden to everyone besides the invoker of the command, otherwise <see langword="false"/>.</param>
- <param name="allowedMentions">The allowed mentions for this response.</param>
- <param name="options">The request options for this response.</param>
- <param name="component">A <see cref="T:Discord.MessageComponent"/> to be sent with this response.</param>
- <param name="embed">A single embed to send with this response. If this is passed alongside an array of embeds, the single embed will be ignored.</param>
- <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">The parameters provided were invalid or the token was invalid.</exception>
- </member>
- <member name="M:Discord.WebSocket.SocketInteraction.FollowupAsync(System.String,Discord.Embed[],System.Boolean,System.Boolean,Discord.AllowedMentions,Discord.RequestOptions,Discord.MessageComponent,Discord.Embed)">
- <summary>
- Sends a followup message for this interaction.
- </summary>
- <param name="text">The text of the message to be sent.</param>
- <param name="embeds">A array of embeds to send with this response. Max 10.</param>
- <param name="isTTS"><see langword="true"/> if the message should be read out by a text-to-speech reader, otherwise <see langword="false"/>.</param>
- <param name="ephemeral"><see langword="true"/> if the response should be hidden to everyone besides the invoker of the command, otherwise <see langword="false"/>.</param>
- <param name="allowedMentions">The allowed mentions for this response.</param>
- <param name="options">The request options for this response.</param>
- <param name="component">A <see cref="T:Discord.MessageComponent"/> to be sent with this response.</param>
- <param name="embed">A single embed to send with this response. If this is passed alongside an array of embeds, the single embed will be ignored.</param>
- <returns>
- The sent message.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketInteraction.FollowupWithFileAsync(System.String,System.IO.Stream,System.String,Discord.Embed[],System.Boolean,System.Boolean,Discord.AllowedMentions,Discord.RequestOptions,Discord.MessageComponent,Discord.Embed)">
- <summary>
- Sends a followup message for this interaction.
- </summary>
- <param name="text">The text of the message to be sent.</param>
- <param name="fileStream">The file to upload.</param>
- <param name="fileName">The file name of the attachment.</param>
- <param name="embeds">A array of embeds to send with this response. Max 10.</param>
- <param name="isTTS"><see langword="true"/> if the message should be read out by a text-to-speech reader, otherwise <see langword="false"/>.</param>
- <param name="ephemeral"><see langword="true"/> if the response should be hidden to everyone besides the invoker of the command, otherwise <see langword="false"/>.</param>
- <param name="allowedMentions">The allowed mentions for this response.</param>
- <param name="options">The request options for this response.</param>
- <param name="component">A <see cref="T:Discord.MessageComponent"/> to be sent with this response.</param>
- <param name="embed">A single embed to send with this response. If this is passed alongside an array of embeds, the single embed will be ignored.</param>
- <returns>
- The sent message.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketInteraction.FollowupWithFileAsync(System.String,System.String,System.String,Discord.Embed[],System.Boolean,System.Boolean,Discord.AllowedMentions,Discord.RequestOptions,Discord.MessageComponent,Discord.Embed)">
- <summary>
- Sends a followup message for this interaction.
- </summary>
- <param name="text">The text of the message to be sent.</param>
- <param name="filePath">The file to upload.</param>
- <param name="fileName">The file name of the attachment.</param>
- <param name="embeds">A array of embeds to send with this response. Max 10.</param>
- <param name="isTTS"><see langword="true"/> if the message should be read out by a text-to-speech reader, otherwise <see langword="false"/>.</param>
- <param name="ephemeral"><see langword="true"/> if the response should be hidden to everyone besides the invoker of the command, otherwise <see langword="false"/>.</param>
- <param name="allowedMentions">The allowed mentions for this response.</param>
- <param name="options">The request options for this response.</param>
- <param name="component">A <see cref="T:Discord.MessageComponent"/> to be sent with this response.</param>
- <param name="embed">A single embed to send with this response. If this is passed alongside an array of embeds, the single embed will be ignored.</param>
- <returns>
- The sent message.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketInteraction.GetOriginalResponseAsync(Discord.RequestOptions)">
- <summary>
- Gets the original response for this interaction.
- </summary>
- <param name="options">The request options for this async request.</param>
- <returns>A <see cref="T:Discord.Rest.RestInteractionMessage"/> that represents the initial response.</returns>
- </member>
- <member name="M:Discord.WebSocket.SocketInteraction.ModifyOriginalResponseAsync(System.Action{Discord.MessageProperties},Discord.RequestOptions)">
- <summary>
- Edits original response for this interaction.
- </summary>
- <param name="func">A delegate containing the properties to modify the message with.</param>
- <param name="options">The request options for this async request.</param>
- <returns>A <see cref="T:Discord.Rest.RestInteractionMessage"/> that represents the initial response.</returns>
- </member>
- <member name="M:Discord.WebSocket.SocketInteraction.DeferAsync(System.Boolean,Discord.RequestOptions)">
- <summary>
- Acknowledges this interaction.
- </summary>
- <param name="ephemeral"><see langword="true"/> to send this message ephemerally, otherwise <see langword="false"/>.</param>
- <param name="options">The request options for this async request.</param>
- <returns>
- A task that represents the asynchronous operation of acknowledging the interaction.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketInteraction.Discord#IDiscordInteraction#FollowupAsync(System.String,Discord.Embed[],System.Boolean,System.Boolean,Discord.AllowedMentions,Discord.RequestOptions,Discord.MessageComponent,Discord.Embed)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketInteraction.Discord#IDiscordInteraction#GetOriginalResponseAsync(Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketInteraction.Discord#IDiscordInteraction#ModifyOriginalResponseAsync(System.Action{Discord.MessageProperties},Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="T:Discord.WebSocket.SocketInvite">
- <summary>
- Represents a WebSocket-based invite to a guild.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.ChannelId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.Channel">
- <summary>
- Gets the channel where this invite was created.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.GuildId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.Guild">
- <summary>
- Gets the guild where this invite was created.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.Discord#IInvite#ChannelType">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.Discord#IInvite#ChannelName">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.Discord#IInvite#GuildName">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.Discord#IInvite#PresenceCount">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.Discord#IInvite#MemberCount">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.IsTemporary">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.Discord#IInviteMetadata#MaxAge">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.Discord#IInviteMetadata#MaxUses">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.Discord#IInviteMetadata#Uses">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.MaxAge">
- <summary>
- Gets the time (in seconds) until the invite expires.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.MaxUses">
- <summary>
- Gets the max number of uses this invite may have.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.Uses">
- <summary>
- Gets the number of times this invite has been used.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.Inviter">
- <summary>
- Gets the user that created this invite if available.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.Discord#IInviteMetadata#CreatedAt">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.CreatedAt">
- <summary>
- Gets when this invite was created.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.TargetUser">
- <summary>
- Gets the user targeted by this invite if available.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.TargetUserType">
- <summary>
- Gets the type of the user targeted by this invite.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.Code">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.Url">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketInvite.DeleteAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketInvite.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.WebSocket.SocketInvite.Discord#IInvite#Guild">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.Discord#IInvite#Channel">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.Discord#IInvite#Inviter">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketInvite.Discord#IInvite#TargetUser">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.MessageCache.GetMany(System.Nullable{System.UInt64},Discord.Direction,System.Int32)">
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="limit"/> is less than 0.</exception>
- </member>
- <member name="T:Discord.WebSocket.SocketMessage">
- <summary>
- Represents a WebSocket-based message.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Author">
- <summary>
- Gets the author of this message.
- </summary>
- <returns>
- A WebSocket-based user object.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Channel">
- <summary>
- Gets the source channel of the message.
- </summary>
- <returns>
- A WebSocket-based message channel.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Source">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Content">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.CreatedAt">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.IsTTS">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.IsPinned">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.IsSuppressed">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.EditedTimestamp">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.MentionedEveryone">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Activity">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Application">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Reference">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Components">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Flags">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Type">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Attachments">
- <summary>
- Returns all attachments included in this message.
- </summary>
- <returns>
- Collection of attachments.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Embeds">
- <summary>
- Returns all embeds included in this message.
- </summary>
- <returns>
- Collection of embed objects.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.MentionedChannels">
- <summary>
- Returns the channels mentioned in this message.
- </summary>
- <returns>
- Collection of WebSocket-based guild channels.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.MentionedRoles">
- <summary>
- Returns the roles mentioned in this message.
- </summary>
- <returns>
- Collection of WebSocket-based roles.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.MentionedUsers">
- <summary>
- Returns the users mentioned in this message.
- </summary>
- <returns>
- Collection of WebSocket-based users.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Tags">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Stickers">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Reactions">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Timestamp">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketMessage.DeleteAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketMessage.ToString">
- <summary>
- Gets the content of the message.
- </summary>
- <returns>
- Content of the message.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Discord#IMessage#Author">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Discord#IMessage#Channel">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Discord#IMessage#Attachments">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Discord#IMessage#Embeds">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Discord#IMessage#MentionedChannelIds">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Discord#IMessage#MentionedRoleIds">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Discord#IMessage#MentionedUserIds">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Discord#IMessage#Components">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketMessage.Discord#IMessage#Stickers">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketMessage.AddReactionAsync(Discord.IEmote,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketMessage.RemoveReactionAsync(Discord.IEmote,Discord.IUser,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketMessage.RemoveReactionAsync(Discord.IEmote,System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketMessage.RemoveAllReactionsAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketMessage.RemoveAllReactionsForEmoteAsync(Discord.IEmote,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketMessage.GetReactionUsersAsync(Discord.IEmote,System.Int32,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="T:Discord.WebSocket.SocketReaction">
- <summary>
- Represents a WebSocket-based reaction object.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketReaction.UserId">
- <summary>
- Gets the ID of the user who added the reaction.
- </summary>
- <remarks>
- This property retrieves the snowflake identifier of the user responsible for this reaction. This
- property will always contain the user identifier in event that
- <see cref="P:Discord.WebSocket.SocketReaction.User" /> cannot be retrieved.
- </remarks>
- <returns>
- A user snowflake identifier associated with the user.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketReaction.User">
- <summary>
- Gets the user who added the reaction if possible.
- </summary>
- <remarks>
- <para>
- This property attempts to retrieve a WebSocket-cached user that is responsible for this reaction from
- the client. In other words, when the user is not in the WebSocket cache, this property may not
- contain a value, leaving the only identifiable information to be
- <see cref="P:Discord.WebSocket.SocketReaction.UserId" />.
- </para>
- <para>
- If you wish to obtain an identifiable user object, consider utilizing
- <see cref="T:Discord.Rest.DiscordRestClient" /> which will attempt to retrieve the user from REST.
- </para>
- </remarks>
- <returns>
- A user object where possible; a value is not always returned.
- </returns>
- <seealso cref="T:Discord.Optional`1"/>
- </member>
- <member name="P:Discord.WebSocket.SocketReaction.MessageId">
- <summary>
- Gets the ID of the message that has been reacted to.
- </summary>
- <returns>
- A message snowflake identifier associated with the message.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketReaction.Message">
- <summary>
- Gets the message that has been reacted to if possible.
- </summary>
- <returns>
- A WebSocket-based message where possible; a value is not always returned.
- </returns>
- <seealso cref="T:Discord.Optional`1"/>
- </member>
- <member name="P:Discord.WebSocket.SocketReaction.Channel">
- <summary>
- Gets the channel where the reaction takes place in.
- </summary>
- <returns>
- A WebSocket-based message channel.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketReaction.Emote">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketReaction.Equals(System.Object)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketReaction.GetHashCode">
- <inheritdoc />
- </member>
- <member name="T:Discord.WebSocket.SocketSystemMessage">
- <summary>
- Represents a WebSocket-based message sent by the system.
- </summary>
- </member>
- <member name="T:Discord.WebSocket.SocketUserMessage">
- <summary>
- Represents a WebSocket-based message sent by a user.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketUserMessage.IsTTS">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUserMessage.IsPinned">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUserMessage.IsSuppressed">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUserMessage.EditedTimestamp">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUserMessage.MentionedEveryone">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUserMessage.Attachments">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUserMessage.Embeds">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUserMessage.Tags">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUserMessage.MentionedChannels">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUserMessage.MentionedRoles">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUserMessage.MentionedUsers">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUserMessage.Stickers">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUserMessage.ReferencedMessage">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketUserMessage.ModifyAsync(System.Action{Discord.MessageProperties},Discord.RequestOptions)">
- <inheritdoc />
- <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="M:Discord.WebSocket.SocketUserMessage.PinAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketUserMessage.UnpinAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketUserMessage.Resolve(Discord.TagHandling,Discord.TagHandling,Discord.TagHandling,Discord.TagHandling,Discord.TagHandling)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketUserMessage.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.WebSocket.SocketRole">
- <summary>
- Represents a WebSocket-based role to be given to a guild user.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketRole.Guild">
- <summary>
- Gets the guild that owns this role.
- </summary>
- <returns>
- A <see cref="T:Discord.WebSocket.SocketGuild"/> representing the parent guild of this role.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketRole.Color">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketRole.IsHoisted">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketRole.IsManaged">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketRole.IsMentionable">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketRole.Name">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketRole.Permissions">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketRole.Position">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketRole.Tags">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketRole.CreatedAt">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketRole.IsEveryone">
- <summary>
- Returns a value that determines if the role is an @everyone role.
- </summary>
- <returns>
- <c>true</c> if the role is @everyone; otherwise <c>false</c>.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketRole.Mention">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketRole.Members">
- <summary>
- Returns an IEnumerable containing all <see cref="T:Discord.WebSocket.SocketGuildUser"/> that have this role.
- </summary>
- </member>
- <member name="M:Discord.WebSocket.SocketRole.ModifyAsync(System.Action{Discord.RoleProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketRole.DeleteAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketRole.ToString">
- <summary>
- Gets the name of the role.
- </summary>
- <returns>
- A string that resolves to <see cref="P:Discord.WebSocket.SocketRole.Name" />.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketRole.CompareTo(Discord.IRole)">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketRole.Discord#IRole#Guild">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketEntity`1.Id">
- <inheritdoc />
- </member>
- <member name="T:Discord.WebSocket.SocketCustomSticker">
- <summary>
- Represents a custom sticker within a guild received over the gateway.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketCustomSticker.Author">
- <summary>
- Gets the user that uploaded the guild sticker.
- </summary>
- <remarks>
- <note>
- This may return <see langword="null"/> in the WebSocket implementation due to incomplete user collection in
- large guilds, or the bot doesnt have the MANAGE_EMOJIS_AND_STICKERS permission.
- </note>
- </remarks>
- </member>
- <member name="P:Discord.WebSocket.SocketCustomSticker.Guild">
- <summary>
- Gets the guild the sticker was created in.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketCustomSticker.AuthorId">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketCustomSticker.ModifyAsync(System.Action{Discord.StickerProperties},Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketCustomSticker.DeleteAsync(Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="T:Discord.WebSocket.SocketSticker">
- <summary>
- Represents a general sticker received over the gateway.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketSticker.PackId">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketSticker.Name">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketSticker.Description">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketSticker.Tags">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketSticker.Type">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketSticker.Format">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketSticker.Available">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketSticker.SortOrder">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketSticker.GetStickerUrl">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketSticker.Equals(System.Object)">
- <inheritdoc/>
- </member>
- <member name="T:Discord.WebSocket.SocketUnknownSticker">
- <summary>
- Represents an unknown sticker received over the gateway.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketUnknownSticker.Tags">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketUnknownSticker.Description">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketUnknownSticker.PackId">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketUnknownSticker.Available">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketUnknownSticker.SortOrder">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketUnknownSticker.Type">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketUnknownSticker.ResolveAsync(Discord.CacheMode,Discord.RequestOptions)">
- <summary>
- Attempts to try to find the sticker.
- </summary>
- <returns>
- The sticker representing this unknown stickers Id, if none is found then <see langword="null"/>.
- </returns>
- </member>
- <member name="T:Discord.WebSocket.SocketGroupUser">
- <summary>
- Represents a WebSocket-based group user.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketGroupUser.Channel">
- <summary>
- Gets the group channel of the user.
- </summary>
- <returns>
- A <see cref="T:Discord.WebSocket.SocketGroupChannel" /> representing the channel of which the user belongs to.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketGroupUser.GlobalUser">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGroupUser.IsBot">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGroupUser.Username">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGroupUser.DiscriminatorValue">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGroupUser.AvatarId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGroupUser.BannerId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGroupUser.AccentColor">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGroupUser.Presence">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGroupUser.IsWebhook">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsDeafened">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsMuted">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsSelfDeafened">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsSelfMuted">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsSuppressed">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#VoiceChannel">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#VoiceSessionId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsStreaming">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#RequestToSpeakTimestamp">
- <inheritdoc />
- </member>
- <member name="T:Discord.WebSocket.SocketGuildUser">
- <summary>
- Represents a WebSocket-based guild user.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.Guild">
- <summary>
- Gets the guild the user is in.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.Nickname">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.IsBot">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.Username">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.DiscriminatorValue">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.AvatarId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.BannerId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.AccentColor">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.GuildPermissions">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.IsWebhook">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.IsSelfDeafened">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.IsSelfMuted">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.IsSuppressed">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.IsDeafened">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.IsMuted">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.IsStreaming">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.RequestToSpeakTimestamp">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.IsPending">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.JoinedAt">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.Roles">
- <summary>
- Returns a collection of roles that the user possesses.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.VoiceChannel">
- <summary>
- Returns the voice channel the user is in, or <c>null</c> if none.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.VoiceSessionId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.VoiceState">
- <summary>
- Gets the voice connection status of the user if any.
- </summary>
- <returns>
- A <see cref="T:Discord.WebSocket.SocketVoiceState" /> representing the user's voice status; <c>null</c> if the user is not
- connected to a voice channel.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.PremiumSince">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.Hierarchy">
- <summary>
- Returns the position of the user within the role hierarchy.
- </summary>
- <remarks>
- The returned value equal to the position of the highest role the user has, or
- <see cref="F:System.Int32.MaxValue"/> if user is the server owner.
- </remarks>
- </member>
- <member name="M:Discord.WebSocket.SocketGuildUser.ModifyAsync(System.Action{Discord.GuildUserProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildUser.KickAsync(System.String,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildUser.AddRoleAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildUser.AddRoleAsync(Discord.IRole,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildUser.AddRolesAsync(System.Collections.Generic.IEnumerable{System.UInt64},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildUser.AddRolesAsync(System.Collections.Generic.IEnumerable{Discord.IRole},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildUser.RemoveRoleAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildUser.RemoveRoleAsync(Discord.IRole,Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildUser.RemoveRolesAsync(System.Collections.Generic.IEnumerable{System.UInt64},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildUser.RemoveRolesAsync(System.Collections.Generic.IEnumerable{Discord.IRole},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketGuildUser.GetPermissions(Discord.IGuildChannel)">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.Discord#IGuildUser#Guild">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.Discord#IGuildUser#GuildId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.Discord#IGuildUser#RoleIds">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketGuildUser.Discord#IVoiceState#VoiceChannel">
- <inheritdoc />
- </member>
- <member name="T:Discord.WebSocket.SocketPresence">
- <summary>
- Represents the WebSocket user's presence status. This may include their online status and their activity.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketPresence.Status">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketPresence.ActiveClients">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketPresence.Activities">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketPresence.ConvertClientTypesDict(System.Collections.Generic.IDictionary{System.String,System.String})">
- <summary>
- Creates a new <see cref="T:System.Collections.Generic.IReadOnlyCollection`1"/> containing all of the client types
- where a user is active from the data supplied in the Presence update frame.
- </summary>
- <param name="clientTypesDict">
- A dictionary keyed by the <see cref="T:Discord.ClientType"/>
- and where the value is the <see cref="T:Discord.UserStatus"/>.
- </param>
- <returns>
- A collection of all <see cref="T:Discord.ClientType"/>s that this user is active.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketPresence.ConvertActivitiesList(System.Collections.Generic.IList{Discord.API.Game})">
- <summary>
- Creates a new <see cref="T:System.Collections.Generic.IReadOnlyCollection`1"/> containing all the activities
- that a user has from the data supplied in the Presence update frame.
- </summary>
- <param name="activities">
- A list of <see cref="T:Discord.API.Game"/>.
- </param>
- <returns>
- A list of all <see cref="T:Discord.IActivity"/> that this user currently has available.
- </returns>
- </member>
- <member name="M:Discord.WebSocket.SocketPresence.ToString">
- <summary>
- Gets the status of the user.
- </summary>
- <returns>
- A string that resolves to <see cref="P:Discord.WebSocket.SocketPresence.Status" />.
- </returns>
- </member>
- <member name="T:Discord.WebSocket.SocketSelfUser">
- <summary>
- Represents the logged-in WebSocket-based user.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketSelfUser.Email">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketSelfUser.IsVerified">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketSelfUser.IsMfaEnabled">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketSelfUser.IsBot">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketSelfUser.Username">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketSelfUser.DiscriminatorValue">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketSelfUser.AvatarId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketSelfUser.BannerId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketSelfUser.AccentColor">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketSelfUser.Presence">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketSelfUser.Flags">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketSelfUser.PremiumType">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketSelfUser.Locale">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketSelfUser.IsWebhook">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketSelfUser.ModifyAsync(System.Action{Discord.SelfUserProperties},Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="T:Discord.WebSocket.SocketThreadUser">
- <summary>
- Represents a thread user received over the gateway.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.Thread">
- <summary>
- Gets the <see cref="T:Discord.WebSocket.SocketThreadChannel"/> this user is in.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.ThreadJoinedAt">
- <summary>
- Gets the timestamp for when this user joined this thread.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.Guild">
- <summary>
- Gets the guild this user is in.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.JoinedAt">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.Nickname">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.PremiumSince">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.IsPending">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.Hierarchy">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.AvatarId">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.BannerId">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.AccentColor">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.DiscriminatorValue">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.IsBot">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.IsWebhook">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.Username">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.IsDeafened">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.IsMuted">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.IsSelfDeafened">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.IsSelfMuted">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.IsSuppressed">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.VoiceChannel">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.VoiceSessionId">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.IsStreaming">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.RequestToSpeakTimestamp">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadUser.GetPermissions(Discord.IGuildChannel)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadUser.KickAsync(System.String,Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadUser.ModifyAsync(System.Action{Discord.GuildUserProperties},Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadUser.AddRoleAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadUser.AddRoleAsync(Discord.IRole,Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadUser.AddRolesAsync(System.Collections.Generic.IEnumerable{System.UInt64},Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadUser.AddRolesAsync(System.Collections.Generic.IEnumerable{Discord.IRole},Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadUser.RemoveRoleAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadUser.RemoveRoleAsync(Discord.IRole,Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadUser.RemoveRolesAsync(System.Collections.Generic.IEnumerable{System.UInt64},Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadUser.RemoveRolesAsync(System.Collections.Generic.IEnumerable{Discord.IRole},Discord.RequestOptions)">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.Discord#IGuildUser#GuildPermissions">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.Discord#IGuildUser#Guild">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.Discord#IGuildUser#GuildId">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketThreadUser.Discord#IGuildUser#RoleIds">
- <inheritdoc/>
- </member>
- <member name="M:Discord.WebSocket.SocketThreadUser.op_Explicit(Discord.WebSocket.SocketThreadUser)~Discord.WebSocket.SocketGuildUser">
- <summary>
- Gets the guild user of this thread user.
- </summary>
- <param name="user"></param>
- </member>
- <member name="T:Discord.WebSocket.SocketUnknownUser">
- <summary>
- Represents a WebSocket-based user that is yet to be recognized by the client.
- </summary>
- <remarks>
- A user may not be recognized due to the user missing from the cache or failed to be recognized properly.
- </remarks>
- </member>
- <member name="P:Discord.WebSocket.SocketUnknownUser.Username">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUnknownUser.DiscriminatorValue">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUnknownUser.AvatarId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUnknownUser.BannerId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUnknownUser.AccentColor">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUnknownUser.IsBot">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUnknownUser.IsWebhook">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUnknownUser.Presence">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUnknownUser.GlobalUser">
- <inheritdoc />
- <exception cref="T:System.NotSupportedException">This field is not supported for an unknown user.</exception>
- </member>
- <member name="T:Discord.WebSocket.SocketUser">
- <summary>
- Represents a WebSocket-based user.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketUser.IsBot">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUser.Username">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUser.DiscriminatorValue">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUser.AvatarId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUser.BannerId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUser.AccentColor">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUser.IsWebhook">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUser.PublicFlags">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUser.CreatedAt">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUser.Discriminator">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUser.Mention">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUser.Status">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUser.ActiveClients">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUser.Activities">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketUser.MutualGuilds">
- <summary>
- Gets mutual guilds shared with this user.
- </summary>
- <remarks>
- This property will only include guilds in the same <see cref="T:Discord.WebSocket.DiscordSocketClient"/>.
- </remarks>
- </member>
- <member name="M:Discord.WebSocket.SocketUser.CreateDMChannelAsync(Discord.RequestOptions)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketUser.GetAvatarUrl(Discord.ImageFormat,System.UInt16)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketUser.GetBannerUrl(Discord.ImageFormat,System.UInt16)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketUser.GetDefaultAvatarUrl">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketUser.ToString">
- <summary>
- Gets the full name of the user (e.g. Example#0001).
- </summary>
- <returns>
- The full name of the user.
- </returns>
- </member>
- <member name="T:Discord.WebSocket.SocketVoiceState">
- <summary>
- Represents a WebSocket user's voice connection status.
- </summary>
- </member>
- <member name="F:Discord.WebSocket.SocketVoiceState.Default">
- <summary>
- Initializes a default <see cref="T:Discord.WebSocket.SocketVoiceState"/> with everything set to <c>null</c> or <c>false</c>.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketVoiceState.VoiceChannel">
- <summary>
- Gets the voice channel that the user is currently in; or <c>null</c> if none.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketVoiceState.VoiceSessionId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketVoiceState.RequestToSpeakTimestamp">
- <inheritdoc/>
- </member>
- <member name="P:Discord.WebSocket.SocketVoiceState.IsMuted">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketVoiceState.IsDeafened">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketVoiceState.IsSuppressed">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketVoiceState.IsSelfMuted">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketVoiceState.IsSelfDeafened">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketVoiceState.IsStreaming">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketVoiceState.ToString">
- <summary>
- Gets the name of this voice channel.
- </summary>
- <returns>
- A string that resolves to name of this voice channel; otherwise "Unknown".
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketVoiceState.Discord#IVoiceState#VoiceChannel">
- <inheritdoc />
- </member>
- <member name="T:Discord.WebSocket.SocketWebhookUser">
- <summary>
- Represents a WebSocket-based webhook user.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.Guild">
- <summary> Gets the guild of this webhook. </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.WebhookId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.Username">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.DiscriminatorValue">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.AvatarId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.BannerId">
- <inheritdoc />
- <exception cref="T:System.NotSupportedException">Webhook users does not support banners.</exception>
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.AccentColor">
- <inheritdoc />
- <exception cref="T:System.NotSupportedException">Webhook users does not support accent colors.</exception>
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.IsBot">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.IsWebhook">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.Presence">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#Guild">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#GuildId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#RoleIds">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#JoinedAt">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#Nickname">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#PremiumSince">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#IsPending">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#Hierarchy">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#GuildPermissions">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#GetPermissions(Discord.IGuildChannel)">
- <inheritdoc />
- </member>
- <member name="M:Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#KickAsync(System.String,Discord.RequestOptions)">
- <inheritdoc />
- <exception cref="T:System.NotSupportedException">Webhook users cannot be kicked.</exception>
- </member>
- <member name="M:Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#ModifyAsync(System.Action{Discord.GuildUserProperties},Discord.RequestOptions)">
- <inheritdoc />
- <exception cref="T:System.NotSupportedException">Webhook users cannot be modified.</exception>
- </member>
- <member name="M:Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#AddRoleAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- <exception cref="T:System.NotSupportedException">Roles are not supported on webhook users.</exception>
- </member>
- <member name="M:Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#AddRoleAsync(Discord.IRole,Discord.RequestOptions)">
- <inheritdoc />
- <exception cref="T:System.NotSupportedException">Roles are not supported on webhook users.</exception>
- </member>
- <member name="M:Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#AddRolesAsync(System.Collections.Generic.IEnumerable{System.UInt64},Discord.RequestOptions)">
- <inheritdoc />
- <exception cref="T:System.NotSupportedException">Roles are not supported on webhook users.</exception>
- </member>
- <member name="M:Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#AddRolesAsync(System.Collections.Generic.IEnumerable{Discord.IRole},Discord.RequestOptions)">
- <inheritdoc />
- <exception cref="T:System.NotSupportedException">Roles are not supported on webhook users.</exception>
- </member>
- <member name="M:Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#RemoveRoleAsync(System.UInt64,Discord.RequestOptions)">
- <inheritdoc />
- <exception cref="T:System.NotSupportedException">Roles are not supported on webhook users.</exception>
- </member>
- <member name="M:Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#RemoveRoleAsync(Discord.IRole,Discord.RequestOptions)">
- <inheritdoc />
- <exception cref="T:System.NotSupportedException">Roles are not supported on webhook users.</exception>
- </member>
- <member name="M:Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#RemoveRolesAsync(System.Collections.Generic.IEnumerable{System.UInt64},Discord.RequestOptions)">
- <inheritdoc />
- <exception cref="T:System.NotSupportedException">Roles are not supported on webhook users.</exception>
- </member>
- <member name="M:Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#RemoveRolesAsync(System.Collections.Generic.IEnumerable{Discord.IRole},Discord.RequestOptions)">
- <inheritdoc />
- <exception cref="T:System.NotSupportedException">Roles are not supported on webhook users.</exception>
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsDeafened">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsMuted">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsSelfDeafened">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsSelfMuted">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsSuppressed">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#VoiceChannel">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#VoiceSessionId">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsStreaming">
- <inheritdoc />
- </member>
- <member name="P:Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#RequestToSpeakTimestamp">
- <inheritdoc />
- </member>
- <member name="T:Discord.WebSocket.SocketVoiceServer">
- <summary>
- Represents a WebSocket-based voice server.
- </summary>
- </member>
- <member name="P:Discord.WebSocket.SocketVoiceServer.Guild">
- <summary>
- Gets the guild associated with the voice server.
- </summary>
- <returns>
- A cached entity of the guild.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketVoiceServer.Endpoint">
- <summary>
- Gets the endpoint URL of the voice server host.
- </summary>
- <returns>
- An URL representing the voice server host.
- </returns>
- </member>
- <member name="P:Discord.WebSocket.SocketVoiceServer.Token">
- <summary>
- Gets the voice connection token.
- </summary>
- <returns>
- A voice connection token.
- </returns>
- </member>
- <member name="T:Discord.WebSocket.GatewayReconnectException">
- <summary>
- The exception thrown when the gateway client has been requested to reconnect.
- </summary>
- </member>
- <member name="M:Discord.WebSocket.GatewayReconnectException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Discord.WebSocket.GatewayReconnectException" /> class with the reconnection
- message.
- </summary>
- <param name="message">The reason why the gateway has been requested to reconnect.</param>
- </member>
- <member name="M:Discord.Audio.AudioClient.#ctor(Discord.WebSocket.SocketGuild,System.Int32,System.UInt64)">
- <summary> Creates a new REST/WebSocket discord client. </summary>
- </member>
- <member name="M:Discord.Audio.AudioClient.Dispose">
- <inheritdoc />
- </member>
- <member name="T:Discord.Audio.Streams.BufferedWriteStream">
- <summary> Wraps another stream with a timed buffer. </summary>
- </member>
- <member name="T:Discord.Audio.Streams.InputStream">
- <summary> Reads the payload from an RTP frame </summary>
- </member>
- <member name="T:Discord.Audio.Streams.OpusDecodeStream">
- <summary> Converts Opus to PCM </summary>
- </member>
- <member name="M:Discord.Audio.Streams.OpusDecodeStream.WriteHeader(System.UInt16,System.UInt32,System.Boolean)">
- <exception cref="T:System.InvalidOperationException">Header received with no payload.</exception>
- </member>
- <member name="M:Discord.Audio.Streams.OpusDecodeStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <exception cref="T:System.InvalidOperationException">Received payload without an RTP header.</exception>
- </member>
- <member name="T:Discord.Audio.Streams.OpusEncodeStream">
- <summary> Converts PCM to Opus </summary>
- </member>
- <member name="T:Discord.Audio.Streams.OutputStream">
- <summary> Wraps an IAudioClient, sending voice data on write. </summary>
- </member>
- <member name="T:Discord.Audio.Streams.RTPReadStream">
- <summary> Reads the payload from an RTP frame </summary>
- </member>
- <member name="M:Discord.Audio.Streams.RTPReadStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <exception cref="T:System.OperationCanceledException">The token has had cancellation requested.</exception>
- <exception cref="T:System.ObjectDisposedException">The associated <see cref="T:System.Threading.CancellationTokenSource" /> has been disposed.</exception>
- </member>
- <member name="T:Discord.Audio.Streams.RTPWriteStream">
- <summary> Wraps data in an RTP frame </summary>
- </member>
- <member name="T:Discord.Audio.Streams.SodiumDecryptStream">
- <summary>
- Decrypts an RTP frame using libsodium.
- </summary>
- </member>
- <member name="T:Discord.Audio.Streams.SodiumEncryptStream">
- <summary>
- Encrypts an RTP frame using libsodium.
- </summary>
- </member>
- <member name="M:Discord.Audio.Streams.SodiumEncryptStream.WriteHeader(System.UInt16,System.UInt32,System.Boolean)">
- <exception cref="T:System.InvalidOperationException">Header received with no payload.</exception>
- </member>
- <member name="M:Discord.Audio.Streams.SodiumEncryptStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <exception cref="T:System.InvalidOperationException">Received payload without an RTP header.</exception>
- <exception cref="T:System.OperationCanceledException">The token has had cancellation requested.</exception>
- <exception cref="T:System.ObjectDisposedException">The associated <see cref="T:System.Threading.CancellationTokenSource" /> has been disposed.</exception>
- </member>
- <member name="T:Discord.Commands.ShardedCommandContext">
- <summary> The sharded variant of <see cref="T:Discord.Commands.ICommandContext"/>, which may contain the client, user, guild, channel, and message. </summary>
- </member>
- <member name="P:Discord.Commands.ShardedCommandContext.Client">
- <summary> Gets the <see cref="T:Discord.WebSocket.DiscordShardedClient"/> that the command is executed with. </summary>
- </member>
- <member name="M:Discord.Commands.ShardedCommandContext.GetShardId(Discord.WebSocket.DiscordShardedClient,Discord.IGuild)">
- <summary> Gets the shard ID of the command context. </summary>
- </member>
- <member name="P:Discord.Commands.ShardedCommandContext.Discord#Commands#ICommandContext#Client">
- <inheritdoc />
- </member>
- <member name="T:Discord.Commands.SocketCommandContext">
- <summary>
- Represents a WebSocket-based context of a command. This may include the client, guild, channel, user, and message.
- </summary>
- </member>
- <member name="P:Discord.Commands.SocketCommandContext.Client">
- <summary>
- Gets the <see cref="T:Discord.WebSocket.DiscordSocketClient" /> that the command is executed with.
- </summary>
- </member>
- <member name="P:Discord.Commands.SocketCommandContext.Guild">
- <summary>
- Gets the <see cref="T:Discord.WebSocket.SocketGuild" /> that the command is executed in.
- </summary>
- </member>
- <member name="P:Discord.Commands.SocketCommandContext.Channel">
- <summary>
- Gets the <see cref="T:Discord.WebSocket.ISocketMessageChannel" /> that the command is executed in.
- </summary>
- </member>
- <member name="P:Discord.Commands.SocketCommandContext.User">
- <summary>
- Gets the <see cref="T:Discord.WebSocket.SocketUser" /> who executed the command.
- </summary>
- </member>
- <member name="P:Discord.Commands.SocketCommandContext.Message">
- <summary>
- Gets the <see cref="T:Discord.WebSocket.SocketUserMessage" /> that the command is interpreted from.
- </summary>
- </member>
- <member name="P:Discord.Commands.SocketCommandContext.IsPrivate">
- <summary>
- Indicates whether the channel that the command is executed in is a private channel.
- </summary>
- </member>
- <member name="M:Discord.Commands.SocketCommandContext.#ctor(Discord.WebSocket.DiscordSocketClient,Discord.WebSocket.SocketUserMessage)">
- <summary>
- Initializes a new <see cref="T:Discord.Commands.SocketCommandContext" /> class with the provided client and message.
- </summary>
- <param name="client">The underlying client.</param>
- <param name="msg">The underlying message.</param>
- </member>
- <member name="P:Discord.Commands.SocketCommandContext.Discord#Commands#ICommandContext#Client">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Commands.SocketCommandContext.Discord#Commands#ICommandContext#Guild">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Commands.SocketCommandContext.Discord#Commands#ICommandContext#Channel">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Commands.SocketCommandContext.Discord#Commands#ICommandContext#User">
- <inheritdoc/>
- </member>
- <member name="P:Discord.Commands.SocketCommandContext.Discord#Commands#ICommandContext#Message">
- <inheritdoc/>
- </member>
- <member name="M:Discord.Net.WebSockets.DefaultWebSocketProvider.Create(System.Net.IWebProxy)">
- <exception cref="T:System.PlatformNotSupportedException">The default WebSocketProvider is not supported on this platform.</exception>
- </member>
- </members>
- </doc>
|