restapi.go 55 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938
  1. // Discordgo - Discord bindings for Go
  2. // Available at https://github.com/bwmarrin/discordgo
  3. // Copyright 2015-2016 Bruce Marriner <bruce@sqls.net>. All rights reserved.
  4. // Use of this source code is governed by a BSD-style
  5. // license that can be found in the LICENSE file.
  6. // This file contains functions for interacting with the Discord REST/JSON API
  7. // at the lowest level.
  8. package discordgo
  9. import (
  10. "bytes"
  11. "encoding/json"
  12. "errors"
  13. "fmt"
  14. "image"
  15. _ "image/jpeg" // For JPEG decoding
  16. _ "image/png" // For PNG decoding
  17. "io"
  18. "io/ioutil"
  19. "log"
  20. "mime/multipart"
  21. "net/http"
  22. "net/url"
  23. "strconv"
  24. "strings"
  25. "time"
  26. )
  27. // ErrJSONUnmarshal is returned for JSON Unmarshall errors.
  28. var ErrJSONUnmarshal = errors.New("json unmarshal")
  29. // Request is the same as RequestWithBucketID but the bucket id is the same as the urlStr
  30. func (s *Session) Request(method, urlStr string, data interface{}) (response []byte, err error) {
  31. return s.RequestWithBucketID(method, urlStr, data, strings.SplitN(urlStr, "?", 2)[0])
  32. }
  33. // RequestWithBucketID makes a (GET/POST/...) Requests to Discord REST API with JSON data.
  34. func (s *Session) RequestWithBucketID(method, urlStr string, data interface{}, bucketID string) (response []byte, err error) {
  35. var body []byte
  36. if data != nil {
  37. body, err = json.Marshal(data)
  38. if err != nil {
  39. return
  40. }
  41. }
  42. return s.request(method, urlStr, "application/json", body, bucketID, 0)
  43. }
  44. // request makes a (GET/POST/...) Requests to Discord REST API.
  45. // Sequence is the sequence number, if it fails with a 502 it will
  46. // retry with sequence+1 until it either succeeds or sequence >= session.MaxRestRetries
  47. func (s *Session) request(method, urlStr, contentType string, b []byte, bucketID string, sequence int) (response []byte, err error) {
  48. if bucketID == "" {
  49. bucketID = strings.SplitN(urlStr, "?", 2)[0]
  50. }
  51. bucket := s.ratelimiter.LockBucket(bucketID)
  52. if s.Debug {
  53. log.Printf("API REQUEST %8s :: %s\n", method, urlStr)
  54. log.Printf("API REQUEST PAYLOAD :: [%s]\n", string(b))
  55. }
  56. req, err := http.NewRequest(method, urlStr, bytes.NewBuffer(b))
  57. if err != nil {
  58. bucket.Release(nil)
  59. return
  60. }
  61. // Not used on initial login..
  62. // TODO: Verify if a login, otherwise complain about no-token
  63. if s.Token != "" {
  64. req.Header.Set("authorization", s.Token)
  65. }
  66. req.Header.Set("Content-Type", contentType)
  67. // TODO: Make a configurable static variable.
  68. req.Header.Set("User-Agent", fmt.Sprintf("DiscordBot (https://github.com/bwmarrin/discordgo, v%s)", VERSION))
  69. if s.Debug {
  70. for k, v := range req.Header {
  71. log.Printf("API REQUEST HEADER :: [%s] = %+v\n", k, v)
  72. }
  73. }
  74. resp, err := s.Client.Do(req)
  75. if err != nil {
  76. bucket.Release(nil)
  77. return
  78. }
  79. defer func() {
  80. err2 := resp.Body.Close()
  81. if err2 != nil {
  82. log.Println("error closing resp body")
  83. }
  84. }()
  85. err = bucket.Release(resp.Header)
  86. if err != nil {
  87. return
  88. }
  89. response, err = ioutil.ReadAll(resp.Body)
  90. if err != nil {
  91. return
  92. }
  93. if s.Debug {
  94. log.Printf("API RESPONSE STATUS :: %s\n", resp.Status)
  95. for k, v := range resp.Header {
  96. log.Printf("API RESPONSE HEADER :: [%s] = %+v\n", k, v)
  97. }
  98. log.Printf("API RESPONSE BODY :: [%s]\n\n\n", response)
  99. }
  100. switch resp.StatusCode {
  101. case http.StatusOK:
  102. case http.StatusCreated:
  103. case http.StatusNoContent:
  104. // TODO check for 401 response, invalidate token if we get one.
  105. case http.StatusBadGateway:
  106. // Retry sending request if possible
  107. if sequence < s.MaxRestRetries {
  108. s.log(LogInformational, "%s Failed (%s), Retrying...", urlStr, resp.Status)
  109. response, err = s.request(method, urlStr, contentType, b, bucketID, sequence+1)
  110. } else {
  111. err = fmt.Errorf("Exceeded Max retries HTTP %s, %s", resp.Status, response)
  112. }
  113. case 429: // TOO MANY REQUESTS - Rate limiting
  114. rl := TooManyRequests{}
  115. err = json.Unmarshal(response, &rl)
  116. if err != nil {
  117. s.log(LogError, "rate limit unmarshal error, %s", err)
  118. return
  119. }
  120. s.log(LogInformational, "Rate Limiting %s, retry in %d", urlStr, rl.RetryAfter)
  121. s.handleEvent(rateLimitEventType, RateLimit{TooManyRequests: &rl, URL: urlStr})
  122. time.Sleep(rl.RetryAfter * time.Millisecond)
  123. // we can make the above smarter
  124. // this method can cause longer delays than required
  125. response, err = s.request(method, urlStr, contentType, b, bucketID, sequence)
  126. default: // Error condition
  127. err = newRestError(req, resp, response)
  128. }
  129. return
  130. }
  131. func unmarshal(data []byte, v interface{}) error {
  132. err := json.Unmarshal(data, v)
  133. if err != nil {
  134. return ErrJSONUnmarshal
  135. }
  136. return nil
  137. }
  138. // ------------------------------------------------------------------------------------------------
  139. // Functions specific to Discord Sessions
  140. // ------------------------------------------------------------------------------------------------
  141. // Login asks the Discord server for an authentication token.
  142. func (s *Session) Login(email, password string) (err error) {
  143. data := struct {
  144. Email string `json:"email"`
  145. Password string `json:"password"`
  146. }{email, password}
  147. response, err := s.RequestWithBucketID("POST", EndpointLogin, data, EndpointLogin)
  148. if err != nil {
  149. return
  150. }
  151. temp := struct {
  152. Token string `json:"token"`
  153. }{}
  154. err = unmarshal(response, &temp)
  155. if err != nil {
  156. return
  157. }
  158. s.Token = temp.Token
  159. return
  160. }
  161. // Register sends a Register request to Discord, and returns the authentication token
  162. // Note that this account is temporary and should be verified for future use.
  163. // Another option is to save the authentication token external, but this isn't recommended.
  164. func (s *Session) Register(username string) (token string, err error) {
  165. data := struct {
  166. Username string `json:"username"`
  167. }{username}
  168. response, err := s.RequestWithBucketID("POST", EndpointRegister, data, EndpointRegister)
  169. if err != nil {
  170. return
  171. }
  172. temp := struct {
  173. Token string `json:"token"`
  174. }{}
  175. err = unmarshal(response, &temp)
  176. if err != nil {
  177. return
  178. }
  179. token = temp.Token
  180. return
  181. }
  182. // Logout sends a logout request to Discord.
  183. // This does not seem to actually invalidate the token. So you can still
  184. // make API calls even after a Logout. So, it seems almost pointless to
  185. // even use.
  186. func (s *Session) Logout() (err error) {
  187. // _, err = s.Request("POST", LOGOUT, fmt.Sprintf(`{"token": "%s"}`, s.Token))
  188. if s.Token == "" {
  189. return
  190. }
  191. data := struct {
  192. Token string `json:"token"`
  193. }{s.Token}
  194. _, err = s.RequestWithBucketID("POST", EndpointLogout, data, EndpointLogout)
  195. return
  196. }
  197. // ------------------------------------------------------------------------------------------------
  198. // Functions specific to Discord Users
  199. // ------------------------------------------------------------------------------------------------
  200. // User returns the user details of the given userID
  201. // userID : A user ID or "@me" which is a shortcut of current user ID
  202. func (s *Session) User(userID string) (st *User, err error) {
  203. body, err := s.RequestWithBucketID("GET", EndpointUser(userID), nil, EndpointUsers)
  204. if err != nil {
  205. return
  206. }
  207. err = unmarshal(body, &st)
  208. return
  209. }
  210. // UserAvatar returns an image.Image of a users Avatar.
  211. // userID : A user ID or "@me" which is a shortcut of current user ID
  212. func (s *Session) UserAvatar(userID string) (img image.Image, err error) {
  213. u, err := s.User(userID)
  214. if err != nil {
  215. return
  216. }
  217. body, err := s.RequestWithBucketID("GET", EndpointUserAvatar(userID, u.Avatar), nil, EndpointUserAvatar("", ""))
  218. if err != nil {
  219. return
  220. }
  221. img, _, err = image.Decode(bytes.NewReader(body))
  222. return
  223. }
  224. // UserUpdate updates a users settings.
  225. func (s *Session) UserUpdate(email, password, username, avatar, newPassword string) (st *User, err error) {
  226. // NOTE: Avatar must be either the hash/id of existing Avatar or
  227. // data:image/png;base64,BASE64_STRING_OF_NEW_AVATAR_PNG
  228. // to set a new avatar.
  229. // If left blank, avatar will be set to null/blank
  230. data := struct {
  231. Email string `json:"email"`
  232. Password string `json:"password"`
  233. Username string `json:"username"`
  234. Avatar string `json:"avatar,omitempty"`
  235. NewPassword string `json:"new_password,omitempty"`
  236. }{email, password, username, avatar, newPassword}
  237. body, err := s.RequestWithBucketID("PATCH", EndpointUser("@me"), data, EndpointUsers)
  238. if err != nil {
  239. return
  240. }
  241. err = unmarshal(body, &st)
  242. return
  243. }
  244. // UserSettings returns the settings for a given user
  245. func (s *Session) UserSettings() (st *Settings, err error) {
  246. body, err := s.RequestWithBucketID("GET", EndpointUserSettings("@me"), nil, EndpointUserSettings(""))
  247. if err != nil {
  248. return
  249. }
  250. err = unmarshal(body, &st)
  251. return
  252. }
  253. // UserUpdateStatus update the user status
  254. // status : The new status (Actual valid status are 'online','idle','dnd','invisible')
  255. func (s *Session) UserUpdateStatus(status Status) (st *Settings, err error) {
  256. if status == StatusOffline {
  257. err = errors.New("You can't set your Status to offline")
  258. return
  259. }
  260. data := struct {
  261. Status Status `json:"status"`
  262. }{status}
  263. body, err := s.RequestWithBucketID("PATCH", EndpointUserSettings("@me"), data, EndpointUserSettings(""))
  264. if err != nil {
  265. return
  266. }
  267. err = unmarshal(body, &st)
  268. return
  269. }
  270. // UserChannels returns an array of Channel structures for all private
  271. // channels.
  272. func (s *Session) UserChannels() (st []*Channel, err error) {
  273. body, err := s.RequestWithBucketID("GET", EndpointUserChannels("@me"), nil, EndpointUserChannels(""))
  274. if err != nil {
  275. return
  276. }
  277. err = unmarshal(body, &st)
  278. return
  279. }
  280. // UserChannelCreate creates a new User (Private) Channel with another User
  281. // recipientID : A user ID for the user to which this channel is opened with.
  282. func (s *Session) UserChannelCreate(recipientID string) (st *Channel, err error) {
  283. data := struct {
  284. RecipientID string `json:"recipient_id"`
  285. }{recipientID}
  286. body, err := s.RequestWithBucketID("POST", EndpointUserChannels("@me"), data, EndpointUserChannels(""))
  287. if err != nil {
  288. return
  289. }
  290. err = unmarshal(body, &st)
  291. return
  292. }
  293. // UserGuilds returns an array of UserGuild structures for all guilds.
  294. // limit : The number guilds that can be returned. (max 100)
  295. // beforeID : If provided all guilds returned will be before given ID.
  296. // afterID : If provided all guilds returned will be after given ID.
  297. func (s *Session) UserGuilds(limit int, beforeID, afterID string) (st []*UserGuild, err error) {
  298. v := url.Values{}
  299. if limit > 0 {
  300. v.Set("limit", strconv.Itoa(limit))
  301. }
  302. if afterID != "" {
  303. v.Set("after", afterID)
  304. }
  305. if beforeID != "" {
  306. v.Set("before", beforeID)
  307. }
  308. uri := EndpointUserGuilds("@me")
  309. if len(v) > 0 {
  310. uri = fmt.Sprintf("%s?%s", uri, v.Encode())
  311. }
  312. body, err := s.RequestWithBucketID("GET", uri, nil, EndpointUserGuilds(""))
  313. if err != nil {
  314. return
  315. }
  316. err = unmarshal(body, &st)
  317. return
  318. }
  319. // UserGuildSettingsEdit Edits the users notification settings for a guild
  320. // guildID : The ID of the guild to edit the settings on
  321. // settings : The settings to update
  322. func (s *Session) UserGuildSettingsEdit(guildID string, settings *UserGuildSettingsEdit) (st *UserGuildSettings, err error) {
  323. body, err := s.RequestWithBucketID("PATCH", EndpointUserGuildSettings("@me", guildID), settings, EndpointUserGuildSettings("", guildID))
  324. if err != nil {
  325. return
  326. }
  327. err = unmarshal(body, &st)
  328. return
  329. }
  330. // UserChannelPermissions returns the permission of a user in a channel.
  331. // userID : The ID of the user to calculate permissions for.
  332. // channelID : The ID of the channel to calculate permission for.
  333. //
  334. // NOTE: This function is now deprecated and will be removed in the future.
  335. // Please see the same function inside state.go
  336. func (s *Session) UserChannelPermissions(userID, channelID string) (apermissions int, err error) {
  337. // Try to just get permissions from state.
  338. apermissions, err = s.State.UserChannelPermissions(userID, channelID)
  339. if err == nil {
  340. return
  341. }
  342. // Otherwise try get as much data from state as possible, falling back to the network.
  343. channel, err := s.State.Channel(channelID)
  344. if err != nil || channel == nil {
  345. channel, err = s.Channel(channelID)
  346. if err != nil {
  347. return
  348. }
  349. }
  350. guild, err := s.State.Guild(channel.GuildID)
  351. if err != nil || guild == nil {
  352. guild, err = s.Guild(channel.GuildID)
  353. if err != nil {
  354. return
  355. }
  356. }
  357. if userID == guild.OwnerID {
  358. apermissions = PermissionAll
  359. return
  360. }
  361. member, err := s.State.Member(guild.ID, userID)
  362. if err != nil || member == nil {
  363. member, err = s.GuildMember(guild.ID, userID)
  364. if err != nil {
  365. return
  366. }
  367. }
  368. return memberPermissions(guild, channel, member), nil
  369. }
  370. // Calculates the permissions for a member.
  371. // https://support.discordapp.com/hc/en-us/articles/206141927-How-is-the-permission-hierarchy-structured-
  372. func memberPermissions(guild *Guild, channel *Channel, member *Member) (apermissions int) {
  373. userID := member.User.ID
  374. if userID == guild.OwnerID {
  375. apermissions = PermissionAll
  376. return
  377. }
  378. for _, role := range guild.Roles {
  379. if role.ID == guild.ID {
  380. apermissions |= role.Permissions
  381. break
  382. }
  383. }
  384. for _, role := range guild.Roles {
  385. for _, roleID := range member.Roles {
  386. if role.ID == roleID {
  387. apermissions |= role.Permissions
  388. break
  389. }
  390. }
  391. }
  392. if apermissions&PermissionAdministrator == PermissionAdministrator {
  393. apermissions |= PermissionAll
  394. }
  395. // Apply @everyone overrides from the channel.
  396. for _, overwrite := range channel.PermissionOverwrites {
  397. if guild.ID == overwrite.ID {
  398. apermissions &= ^overwrite.Deny
  399. apermissions |= overwrite.Allow
  400. break
  401. }
  402. }
  403. denies := 0
  404. allows := 0
  405. // Member overwrites can override role overrides, so do two passes
  406. for _, overwrite := range channel.PermissionOverwrites {
  407. for _, roleID := range member.Roles {
  408. if overwrite.Type == "role" && roleID == overwrite.ID {
  409. denies |= overwrite.Deny
  410. allows |= overwrite.Allow
  411. break
  412. }
  413. }
  414. }
  415. apermissions &= ^denies
  416. apermissions |= allows
  417. for _, overwrite := range channel.PermissionOverwrites {
  418. if overwrite.Type == "member" && overwrite.ID == userID {
  419. apermissions &= ^overwrite.Deny
  420. apermissions |= overwrite.Allow
  421. break
  422. }
  423. }
  424. if apermissions&PermissionAdministrator == PermissionAdministrator {
  425. apermissions |= PermissionAllChannel
  426. }
  427. return apermissions
  428. }
  429. // ------------------------------------------------------------------------------------------------
  430. // Functions specific to Discord Guilds
  431. // ------------------------------------------------------------------------------------------------
  432. // Guild returns a Guild structure of a specific Guild.
  433. // guildID : The ID of a Guild
  434. func (s *Session) Guild(guildID string) (st *Guild, err error) {
  435. if s.StateEnabled {
  436. // Attempt to grab the guild from State first.
  437. st, err = s.State.Guild(guildID)
  438. if err == nil {
  439. return
  440. }
  441. }
  442. body, err := s.RequestWithBucketID("GET", EndpointGuild(guildID), nil, EndpointGuild(guildID))
  443. if err != nil {
  444. return
  445. }
  446. err = unmarshal(body, &st)
  447. return
  448. }
  449. // GuildCreate creates a new Guild
  450. // name : A name for the Guild (2-100 characters)
  451. func (s *Session) GuildCreate(name string) (st *Guild, err error) {
  452. data := struct {
  453. Name string `json:"name"`
  454. }{name}
  455. body, err := s.RequestWithBucketID("POST", EndpointGuilds, data, EndpointGuilds)
  456. if err != nil {
  457. return
  458. }
  459. err = unmarshal(body, &st)
  460. return
  461. }
  462. // GuildEdit edits a new Guild
  463. // guildID : The ID of a Guild
  464. // g : A GuildParams struct with the values Name, Region and VerificationLevel defined.
  465. func (s *Session) GuildEdit(guildID string, g GuildParams) (st *Guild, err error) {
  466. // Bounds checking for VerificationLevel, interval: [0, 3]
  467. if g.VerificationLevel != nil {
  468. val := *g.VerificationLevel
  469. if val < 0 || val > 3 {
  470. err = errors.New("VerificationLevel out of bounds, should be between 0 and 3")
  471. return
  472. }
  473. }
  474. //Bounds checking for regions
  475. if g.Region != "" {
  476. isValid := false
  477. regions, _ := s.VoiceRegions()
  478. for _, r := range regions {
  479. if g.Region == r.ID {
  480. isValid = true
  481. }
  482. }
  483. if !isValid {
  484. var valid []string
  485. for _, r := range regions {
  486. valid = append(valid, r.ID)
  487. }
  488. err = fmt.Errorf("Region not a valid region (%q)", valid)
  489. return
  490. }
  491. }
  492. data := struct {
  493. Name string `json:"name,omitempty"`
  494. Region string `json:"region,omitempty"`
  495. VerificationLevel *VerificationLevel `json:"verification_level,omitempty"`
  496. }{g.Name, g.Region, g.VerificationLevel}
  497. body, err := s.RequestWithBucketID("PATCH", EndpointGuild(guildID), data, EndpointGuild(guildID))
  498. if err != nil {
  499. return
  500. }
  501. err = unmarshal(body, &st)
  502. return
  503. }
  504. // GuildDelete deletes a Guild.
  505. // guildID : The ID of a Guild
  506. func (s *Session) GuildDelete(guildID string) (st *Guild, err error) {
  507. body, err := s.RequestWithBucketID("DELETE", EndpointGuild(guildID), nil, EndpointGuild(guildID))
  508. if err != nil {
  509. return
  510. }
  511. err = unmarshal(body, &st)
  512. return
  513. }
  514. // GuildLeave leaves a Guild.
  515. // guildID : The ID of a Guild
  516. func (s *Session) GuildLeave(guildID string) (err error) {
  517. _, err = s.RequestWithBucketID("DELETE", EndpointUserGuild("@me", guildID), nil, EndpointUserGuild("", guildID))
  518. return
  519. }
  520. // GuildBans returns an array of User structures for all bans of a
  521. // given guild.
  522. // guildID : The ID of a Guild.
  523. func (s *Session) GuildBans(guildID string) (st []*GuildBan, err error) {
  524. body, err := s.RequestWithBucketID("GET", EndpointGuildBans(guildID), nil, EndpointGuildBans(guildID))
  525. if err != nil {
  526. return
  527. }
  528. err = unmarshal(body, &st)
  529. return
  530. }
  531. // GuildBanCreate bans the given user from the given guild.
  532. // guildID : The ID of a Guild.
  533. // userID : The ID of a User
  534. // days : The number of days of previous comments to delete.
  535. func (s *Session) GuildBanCreate(guildID, userID string, days int) (err error) {
  536. uri := EndpointGuildBan(guildID, userID)
  537. if days > 0 {
  538. uri = fmt.Sprintf("%s?delete-message-days=%d", uri, days)
  539. }
  540. _, err = s.RequestWithBucketID("PUT", uri, nil, EndpointGuildBan(guildID, ""))
  541. return
  542. }
  543. // GuildBanDelete removes the given user from the guild bans
  544. // guildID : The ID of a Guild.
  545. // userID : The ID of a User
  546. func (s *Session) GuildBanDelete(guildID, userID string) (err error) {
  547. _, err = s.RequestWithBucketID("DELETE", EndpointGuildBan(guildID, userID), nil, EndpointGuildBan(guildID, ""))
  548. return
  549. }
  550. // GuildMembers returns a list of members for a guild.
  551. // guildID : The ID of a Guild.
  552. // after : The id of the member to return members after
  553. // limit : max number of members to return (max 1000)
  554. func (s *Session) GuildMembers(guildID string, after string, limit int) (st []*Member, err error) {
  555. uri := EndpointGuildMembers(guildID)
  556. v := url.Values{}
  557. if after != "" {
  558. v.Set("after", after)
  559. }
  560. if limit > 0 {
  561. v.Set("limit", strconv.Itoa(limit))
  562. }
  563. if len(v) > 0 {
  564. uri = fmt.Sprintf("%s?%s", uri, v.Encode())
  565. }
  566. body, err := s.RequestWithBucketID("GET", uri, nil, EndpointGuildMembers(guildID))
  567. if err != nil {
  568. return
  569. }
  570. err = unmarshal(body, &st)
  571. return
  572. }
  573. // GuildMember returns a member of a guild.
  574. // guildID : The ID of a Guild.
  575. // userID : The ID of a User
  576. func (s *Session) GuildMember(guildID, userID string) (st *Member, err error) {
  577. body, err := s.RequestWithBucketID("GET", EndpointGuildMember(guildID, userID), nil, EndpointGuildMember(guildID, ""))
  578. if err != nil {
  579. return
  580. }
  581. err = unmarshal(body, &st)
  582. return
  583. }
  584. // GuildMemberDelete removes the given user from the given guild.
  585. // guildID : The ID of a Guild.
  586. // userID : The ID of a User
  587. func (s *Session) GuildMemberDelete(guildID, userID string) (err error) {
  588. _, err = s.RequestWithBucketID("DELETE", EndpointGuildMember(guildID, userID), nil, EndpointGuildMember(guildID, ""))
  589. return
  590. }
  591. // GuildMemberEdit edits the roles of a member.
  592. // guildID : The ID of a Guild.
  593. // userID : The ID of a User.
  594. // roles : A list of role ID's to set on the member.
  595. func (s *Session) GuildMemberEdit(guildID, userID string, roles []string) (err error) {
  596. data := struct {
  597. Roles []string `json:"roles"`
  598. }{roles}
  599. _, err = s.RequestWithBucketID("PATCH", EndpointGuildMember(guildID, userID), data, EndpointGuildMember(guildID, ""))
  600. if err != nil {
  601. return
  602. }
  603. return
  604. }
  605. // GuildMemberMove moves a guild member from one voice channel to another/none
  606. // guildID : The ID of a Guild.
  607. // userID : The ID of a User.
  608. // channelID : The ID of a channel to move user to, or null?
  609. // NOTE : I am not entirely set on the name of this function and it may change
  610. // prior to the final 1.0.0 release of Discordgo
  611. func (s *Session) GuildMemberMove(guildID, userID, channelID string) (err error) {
  612. data := struct {
  613. ChannelID string `json:"channel_id"`
  614. }{channelID}
  615. _, err = s.RequestWithBucketID("PATCH", EndpointGuildMember(guildID, userID), data, EndpointGuildMember(guildID, ""))
  616. if err != nil {
  617. return
  618. }
  619. return
  620. }
  621. // GuildMemberNickname updates the nickname of a guild member
  622. // guildID : The ID of a guild
  623. // userID : The ID of a user
  624. // userID : The ID of a user or "@me" which is a shortcut of the current user ID
  625. func (s *Session) GuildMemberNickname(guildID, userID, nickname string) (err error) {
  626. data := struct {
  627. Nick string `json:"nick"`
  628. }{nickname}
  629. if userID == "@me" {
  630. userID += "/nick"
  631. }
  632. _, err = s.RequestWithBucketID("PATCH", EndpointGuildMember(guildID, userID), data, EndpointGuildMember(guildID, ""))
  633. return
  634. }
  635. // GuildMemberRoleAdd adds the specified role to a given member
  636. // guildID : The ID of a Guild.
  637. // userID : The ID of a User.
  638. // roleID : The ID of a Role to be assigned to the user.
  639. func (s *Session) GuildMemberRoleAdd(guildID, userID, roleID string) (err error) {
  640. _, err = s.RequestWithBucketID("PUT", EndpointGuildMemberRole(guildID, userID, roleID), nil, EndpointGuildMemberRole(guildID, "", ""))
  641. return
  642. }
  643. // GuildMemberRoleRemove removes the specified role to a given member
  644. // guildID : The ID of a Guild.
  645. // userID : The ID of a User.
  646. // roleID : The ID of a Role to be removed from the user.
  647. func (s *Session) GuildMemberRoleRemove(guildID, userID, roleID string) (err error) {
  648. _, err = s.RequestWithBucketID("DELETE", EndpointGuildMemberRole(guildID, userID, roleID), nil, EndpointGuildMemberRole(guildID, "", ""))
  649. return
  650. }
  651. // GuildChannels returns an array of Channel structures for all channels of a
  652. // given guild.
  653. // guildID : The ID of a Guild.
  654. func (s *Session) GuildChannels(guildID string) (st []*Channel, err error) {
  655. body, err := s.request("GET", EndpointGuildChannels(guildID), "", nil, EndpointGuildChannels(guildID), 0)
  656. if err != nil {
  657. return
  658. }
  659. err = unmarshal(body, &st)
  660. return
  661. }
  662. // GuildChannelCreate creates a new channel in the given guild
  663. // guildID : The ID of a Guild.
  664. // name : Name of the channel (2-100 chars length)
  665. // ctype : Tpye of the channel (voice or text)
  666. func (s *Session) GuildChannelCreate(guildID, name, ctype string) (st *Channel, err error) {
  667. data := struct {
  668. Name string `json:"name"`
  669. Type string `json:"type"`
  670. }{name, ctype}
  671. body, err := s.RequestWithBucketID("POST", EndpointGuildChannels(guildID), data, EndpointGuildChannels(guildID))
  672. if err != nil {
  673. return
  674. }
  675. err = unmarshal(body, &st)
  676. return
  677. }
  678. // GuildChannelsReorder updates the order of channels in a guild
  679. // guildID : The ID of a Guild.
  680. // channels : Updated channels.
  681. func (s *Session) GuildChannelsReorder(guildID string, channels []*Channel) (err error) {
  682. _, err = s.RequestWithBucketID("PATCH", EndpointGuildChannels(guildID), channels, EndpointGuildChannels(guildID))
  683. return
  684. }
  685. // GuildInvites returns an array of Invite structures for the given guild
  686. // guildID : The ID of a Guild.
  687. func (s *Session) GuildInvites(guildID string) (st []*Invite, err error) {
  688. body, err := s.RequestWithBucketID("GET", EndpointGuildInvites(guildID), nil, EndpointGuildInivtes(guildID))
  689. if err != nil {
  690. return
  691. }
  692. err = unmarshal(body, &st)
  693. return
  694. }
  695. // GuildRoles returns all roles for a given guild.
  696. // guildID : The ID of a Guild.
  697. func (s *Session) GuildRoles(guildID string) (st []*Role, err error) {
  698. body, err := s.RequestWithBucketID("GET", EndpointGuildRoles(guildID), nil, EndpointGuildRoles(guildID))
  699. if err != nil {
  700. return
  701. }
  702. err = unmarshal(body, &st)
  703. return // TODO return pointer
  704. }
  705. // GuildRoleCreate returns a new Guild Role.
  706. // guildID: The ID of a Guild.
  707. func (s *Session) GuildRoleCreate(guildID string) (st *Role, err error) {
  708. body, err := s.RequestWithBucketID("POST", EndpointGuildRoles(guildID), nil, EndpointGuildRoles(guildID))
  709. if err != nil {
  710. return
  711. }
  712. err = unmarshal(body, &st)
  713. return
  714. }
  715. // GuildRoleEdit updates an existing Guild Role with new values
  716. // guildID : The ID of a Guild.
  717. // roleID : The ID of a Role.
  718. // name : The name of the Role.
  719. // color : The color of the role (decimal, not hex).
  720. // hoist : Whether to display the role's users separately.
  721. // perm : The permissions for the role.
  722. // mention : Whether this role is mentionable
  723. func (s *Session) GuildRoleEdit(guildID, roleID, name string, color int, hoist bool, perm int, mention bool) (st *Role, err error) {
  724. // Prevent sending a color int that is too big.
  725. if color > 0xFFFFFF {
  726. err = fmt.Errorf("color value cannot be larger than 0xFFFFFF")
  727. }
  728. data := struct {
  729. Name string `json:"name"` // The role's name (overwrites existing)
  730. Color int `json:"color"` // The color the role should have (as a decimal, not hex)
  731. Hoist bool `json:"hoist"` // Whether to display the role's users separately
  732. Permissions int `json:"permissions"` // The overall permissions number of the role (overwrites existing)
  733. Mentionable bool `json:"mentionable"` // Whether this role is mentionable
  734. }{name, color, hoist, perm, mention}
  735. body, err := s.RequestWithBucketID("PATCH", EndpointGuildRole(guildID, roleID), data, EndpointGuildRole(guildID, ""))
  736. if err != nil {
  737. return
  738. }
  739. err = unmarshal(body, &st)
  740. return
  741. }
  742. // GuildRoleReorder reoders guild roles
  743. // guildID : The ID of a Guild.
  744. // roles : A list of ordered roles.
  745. func (s *Session) GuildRoleReorder(guildID string, roles []*Role) (st []*Role, err error) {
  746. body, err := s.RequestWithBucketID("PATCH", EndpointGuildRoles(guildID), roles, EndpointGuildRoles(guildID))
  747. if err != nil {
  748. return
  749. }
  750. err = unmarshal(body, &st)
  751. return
  752. }
  753. // GuildRoleDelete deletes an existing role.
  754. // guildID : The ID of a Guild.
  755. // roleID : The ID of a Role.
  756. func (s *Session) GuildRoleDelete(guildID, roleID string) (err error) {
  757. _, err = s.RequestWithBucketID("DELETE", EndpointGuildRole(guildID, roleID), nil, EndpointGuildRole(guildID, ""))
  758. return
  759. }
  760. // GuildPruneCount Returns the number of members that would be removed in a prune operation.
  761. // Requires 'KICK_MEMBER' permission.
  762. // guildID : The ID of a Guild.
  763. // days : The number of days to count prune for (1 or more).
  764. func (s *Session) GuildPruneCount(guildID string, days uint32) (count uint32, err error) {
  765. count = 0
  766. if days <= 0 {
  767. err = errors.New("the number of days should be more than or equal to 1")
  768. return
  769. }
  770. p := struct {
  771. Pruned uint32 `json:"pruned"`
  772. }{}
  773. uri := EndpointGuildPrune(guildID) + fmt.Sprintf("?days=%d", days)
  774. body, err := s.RequestWithBucketID("GET", uri, nil, EndpointGuildPrune(guildID))
  775. err = unmarshal(body, &p)
  776. if err != nil {
  777. return
  778. }
  779. count = p.Pruned
  780. return
  781. }
  782. // GuildPrune Begin as prune operation. Requires the 'KICK_MEMBERS' permission.
  783. // Returns an object with one 'pruned' key indicating the number of members that were removed in the prune operation.
  784. // guildID : The ID of a Guild.
  785. // days : The number of days to count prune for (1 or more).
  786. func (s *Session) GuildPrune(guildID string, days uint32) (count uint32, err error) {
  787. count = 0
  788. if days <= 0 {
  789. err = errors.New("the number of days should be more than or equal to 1")
  790. return
  791. }
  792. data := struct {
  793. days uint32
  794. }{days}
  795. p := struct {
  796. Pruned uint32 `json:"pruned"`
  797. }{}
  798. body, err := s.RequestWithBucketID("POST", EndpointGuildPrune(guildID), data, EndpointGuildPrune(guildID))
  799. if err != nil {
  800. return
  801. }
  802. err = unmarshal(body, &p)
  803. if err != nil {
  804. return
  805. }
  806. count = p.Pruned
  807. return
  808. }
  809. // GuildIntegrations returns an array of Integrations for a guild.
  810. // guildID : The ID of a Guild.
  811. func (s *Session) GuildIntegrations(guildID string) (st []*GuildIntegration, err error) {
  812. body, err := s.RequestWithBucketID("GET", EndpointGuildIntegrations(guildID), nil, EndpointGuildIntegrations(guildID))
  813. if err != nil {
  814. return
  815. }
  816. err = unmarshal(body, &st)
  817. return
  818. }
  819. // GuildIntegrationCreate creates a Guild Integration.
  820. // guildID : The ID of a Guild.
  821. // integrationType : The Integration type.
  822. // integrationID : The ID of an integration.
  823. func (s *Session) GuildIntegrationCreate(guildID, integrationType, integrationID string) (err error) {
  824. data := struct {
  825. Type string `json:"type"`
  826. ID string `json:"id"`
  827. }{integrationType, integrationID}
  828. _, err = s.RequestWithBucketID("POST", EndpointGuildIntegrations(guildID), data, EndpointGuildIntegrations(guildID))
  829. return
  830. }
  831. // GuildIntegrationEdit edits a Guild Integration.
  832. // guildID : The ID of a Guild.
  833. // integrationType : The Integration type.
  834. // integrationID : The ID of an integration.
  835. // expireBehavior : The behavior when an integration subscription lapses (see the integration object documentation).
  836. // expireGracePeriod : Period (in seconds) where the integration will ignore lapsed subscriptions.
  837. // enableEmoticons : Whether emoticons should be synced for this integration (twitch only currently).
  838. func (s *Session) GuildIntegrationEdit(guildID, integrationID string, expireBehavior, expireGracePeriod int, enableEmoticons bool) (err error) {
  839. data := struct {
  840. ExpireBehavior int `json:"expire_behavior"`
  841. ExpireGracePeriod int `json:"expire_grace_period"`
  842. EnableEmoticons bool `json:"enable_emoticons"`
  843. }{expireBehavior, expireGracePeriod, enableEmoticons}
  844. _, err = s.RequestWithBucketID("PATCH", EndpointGuildIntegration(guildID, integrationID), data, EndpointGuildIntegration(guildID, ""))
  845. return
  846. }
  847. // GuildIntegrationDelete removes the given integration from the Guild.
  848. // guildID : The ID of a Guild.
  849. // integrationID : The ID of an integration.
  850. func (s *Session) GuildIntegrationDelete(guildID, integrationID string) (err error) {
  851. _, err = s.RequestWithBucketID("DELETE", EndpointGuildIntegration(guildID, integrationID), nil, EndpointGuildIntegration(guildID, ""))
  852. return
  853. }
  854. // GuildIntegrationSync syncs an integration.
  855. // guildID : The ID of a Guild.
  856. // integrationID : The ID of an integration.
  857. func (s *Session) GuildIntegrationSync(guildID, integrationID string) (err error) {
  858. _, err = s.RequestWithBucketID("POST", EndpointGuildIntegrationSync(guildID, integrationID), nil, EndpointGuildIntegration(guildID, ""))
  859. return
  860. }
  861. // GuildIcon returns an image.Image of a guild icon.
  862. // guildID : The ID of a Guild.
  863. func (s *Session) GuildIcon(guildID string) (img image.Image, err error) {
  864. g, err := s.Guild(guildID)
  865. if err != nil {
  866. return
  867. }
  868. if g.Icon == "" {
  869. err = errors.New("guild does not have an icon set")
  870. return
  871. }
  872. body, err := s.RequestWithBucketID("GET", EndpointGuildIcon(guildID, g.Icon), nil, EndpointGuildIcon(guildID, ""))
  873. if err != nil {
  874. return
  875. }
  876. img, _, err = image.Decode(bytes.NewReader(body))
  877. return
  878. }
  879. // GuildSplash returns an image.Image of a guild splash image.
  880. // guildID : The ID of a Guild.
  881. func (s *Session) GuildSplash(guildID string) (img image.Image, err error) {
  882. g, err := s.Guild(guildID)
  883. if err != nil {
  884. return
  885. }
  886. if g.Splash == "" {
  887. err = errors.New("guild does not have a splash set")
  888. return
  889. }
  890. body, err := s.RequestWithBucketID("GET", EndpointGuildSplash(guildID, g.Splash), nil, EndpointGuildSplash(guildID, ""))
  891. if err != nil {
  892. return
  893. }
  894. img, _, err = image.Decode(bytes.NewReader(body))
  895. return
  896. }
  897. // GuildEmbed returns the embed for a Guild.
  898. // guildID : The ID of a Guild.
  899. func (s *Session) GuildEmbed(guildID string) (st *GuildEmbed, err error) {
  900. body, err := s.RequestWithBucketID("GET", EndpointGuildEmbed(guildID), nil, EndpointGuildEmbed(guildID))
  901. if err != nil {
  902. return
  903. }
  904. err = unmarshal(body, &st)
  905. return
  906. }
  907. // GuildEmbedEdit returns the embed for a Guild.
  908. // guildID : The ID of a Guild.
  909. func (s *Session) GuildEmbedEdit(guildID string, enabled bool, channelID string) (err error) {
  910. data := GuildEmbed{enabled, channelID}
  911. _, err = s.RequestWithBucketID("PATCH", EndpointGuildEmbed(guildID), data, EndpointGuildEmbed(guildID))
  912. return
  913. }
  914. // ------------------------------------------------------------------------------------------------
  915. // Functions specific to Discord Channels
  916. // ------------------------------------------------------------------------------------------------
  917. // Channel returns a Channel strucutre of a specific Channel.
  918. // channelID : The ID of the Channel you want returned.
  919. func (s *Session) Channel(channelID string) (st *Channel, err error) {
  920. body, err := s.RequestWithBucketID("GET", EndpointChannel(channelID), nil, EndpointChannel(channelID))
  921. if err != nil {
  922. return
  923. }
  924. err = unmarshal(body, &st)
  925. return
  926. }
  927. // ChannelEdit edits the given channel
  928. // channelID : The ID of a Channel
  929. // name : The new name to assign the channel.
  930. func (s *Session) ChannelEdit(channelID, name string) (st *Channel, err error) {
  931. data := struct {
  932. Name string `json:"name"`
  933. }{name}
  934. body, err := s.RequestWithBucketID("PATCH", EndpointChannel(channelID), data, EndpointChannel(channelID))
  935. if err != nil {
  936. return
  937. }
  938. err = unmarshal(body, &st)
  939. return
  940. }
  941. // ChannelDelete deletes the given channel
  942. // channelID : The ID of a Channel
  943. func (s *Session) ChannelDelete(channelID string) (st *Channel, err error) {
  944. body, err := s.RequestWithBucketID("DELETE", EndpointChannel(channelID), nil, EndpointChannel(channelID))
  945. if err != nil {
  946. return
  947. }
  948. err = unmarshal(body, &st)
  949. return
  950. }
  951. // ChannelTyping broadcasts to all members that authenticated user is typing in
  952. // the given channel.
  953. // channelID : The ID of a Channel
  954. func (s *Session) ChannelTyping(channelID string) (err error) {
  955. _, err = s.RequestWithBucketID("POST", EndpointChannelTyping(channelID), nil, EndpointChannelTyping(channelID))
  956. return
  957. }
  958. // ChannelMessages returns an array of Message structures for messages within
  959. // a given channel.
  960. // channelID : The ID of a Channel.
  961. // limit : The number messages that can be returned. (max 100)
  962. // beforeID : If provided all messages returned will be before given ID.
  963. // afterID : If provided all messages returned will be after given ID.
  964. // aroundID : If provided all messages returned will be around given ID.
  965. func (s *Session) ChannelMessages(channelID string, limit int, beforeID, afterID, aroundID string) (st []*Message, err error) {
  966. uri := EndpointChannelMessages(channelID)
  967. v := url.Values{}
  968. if limit > 0 {
  969. v.Set("limit", strconv.Itoa(limit))
  970. }
  971. if afterID != "" {
  972. v.Set("after", afterID)
  973. }
  974. if beforeID != "" {
  975. v.Set("before", beforeID)
  976. }
  977. if aroundID != "" {
  978. v.Set("around", aroundID)
  979. }
  980. if len(v) > 0 {
  981. uri = fmt.Sprintf("%s?%s", uri, v.Encode())
  982. }
  983. body, err := s.RequestWithBucketID("GET", uri, nil, EndpointChannelMessages(channelID))
  984. if err != nil {
  985. return
  986. }
  987. err = unmarshal(body, &st)
  988. return
  989. }
  990. // ChannelMessage gets a single message by ID from a given channel.
  991. // channeld : The ID of a Channel
  992. // messageID : the ID of a Message
  993. func (s *Session) ChannelMessage(channelID, messageID string) (st *Message, err error) {
  994. response, err := s.RequestWithBucketID("GET", EndpointChannelMessage(channelID, messageID), nil, EndpointChannelMessage(channelID, ""))
  995. if err != nil {
  996. return
  997. }
  998. err = unmarshal(response, &st)
  999. return
  1000. }
  1001. // ChannelMessageAck acknowledges and marks the given message as read
  1002. // channeld : The ID of a Channel
  1003. // messageID : the ID of a Message
  1004. // lastToken : token returned by last ack
  1005. func (s *Session) ChannelMessageAck(channelID, messageID, lastToken string) (st *Ack, err error) {
  1006. body, err := s.RequestWithBucketID("POST", EndpointChannelMessageAck(channelID, messageID), &Ack{Token: lastToken}, EndpointChannelMessageAck(channelID, ""))
  1007. if err != nil {
  1008. return
  1009. }
  1010. err = unmarshal(body, &st)
  1011. return
  1012. }
  1013. // channelMessageSend sends a message to the given channel.
  1014. // channelID : The ID of a Channel.
  1015. // content : The message to send.
  1016. // tts : Whether to send the message with TTS.
  1017. func (s *Session) channelMessageSend(channelID, content string, tts bool) (st *Message, err error) {
  1018. // TODO: nonce string ?
  1019. data := struct {
  1020. Content string `json:"content"`
  1021. TTS bool `json:"tts"`
  1022. }{content, tts}
  1023. // Send the message to the given channel
  1024. response, err := s.RequestWithBucketID("POST", EndpointChannelMessages(channelID), data, EndpointChannelMessages(channelID))
  1025. if err != nil {
  1026. return
  1027. }
  1028. err = unmarshal(response, &st)
  1029. return
  1030. }
  1031. // ChannelMessageSend sends a message to the given channel.
  1032. // channelID : The ID of a Channel.
  1033. // content : The message to send.
  1034. func (s *Session) ChannelMessageSend(channelID string, content string) (st *Message, err error) {
  1035. return s.channelMessageSend(channelID, content, false)
  1036. }
  1037. // ChannelMessageSendTTS sends a message to the given channel with Text to Speech.
  1038. // channelID : The ID of a Channel.
  1039. // content : The message to send.
  1040. func (s *Session) ChannelMessageSendTTS(channelID string, content string) (st *Message, err error) {
  1041. return s.channelMessageSend(channelID, content, true)
  1042. }
  1043. // ChannelMessageSendEmbed sends a message to the given channel with embedded data (bot only).
  1044. // channelID : The ID of a Channel.
  1045. // embed : The embed data to send.
  1046. func (s *Session) ChannelMessageSendEmbed(channelID string, embed *MessageEmbed) (st *Message, err error) {
  1047. if embed != nil && embed.Type == "" {
  1048. embed.Type = "rich"
  1049. }
  1050. data := struct {
  1051. Embed *MessageEmbed `json:"embed"`
  1052. }{embed}
  1053. // Send the message to the given channel
  1054. response, err := s.RequestWithBucketID("POST", EndpointChannelMessages(channelID), data, EndpointChannelMessages(channelID))
  1055. if err != nil {
  1056. return
  1057. }
  1058. err = unmarshal(response, &st)
  1059. return
  1060. }
  1061. // ChannelMessageEdit edits an existing message, replacing it entirely with
  1062. // the given content.
  1063. // channeld : The ID of a Channel
  1064. // messageID : the ID of a Message
  1065. func (s *Session) ChannelMessageEdit(channelID, messageID, content string) (st *Message, err error) {
  1066. data := struct {
  1067. Content string `json:"content"`
  1068. }{content}
  1069. response, err := s.RequestWithBucketID("PATCH", EndpointChannelMessage(channelID, messageID), data, EndpointChannelMessage(channelID, ""))
  1070. if err != nil {
  1071. return
  1072. }
  1073. err = unmarshal(response, &st)
  1074. return
  1075. }
  1076. // ChannelMessageEditEmbed edits an existing message with embedded data (bot only).
  1077. // channelID : The ID of a Channel
  1078. // messageID : The ID of a Message
  1079. // embed : The embed data to send
  1080. func (s *Session) ChannelMessageEditEmbed(channelID, messageID string, embed *MessageEmbed) (st *Message, err error) {
  1081. if embed != nil && embed.Type == "" {
  1082. embed.Type = "rich"
  1083. }
  1084. data := struct {
  1085. Embed *MessageEmbed `json:"embed"`
  1086. }{embed}
  1087. response, err := s.RequestWithBucketID("PATCH", EndpointChannelMessage(channelID, messageID), data, EndpointChannelMessage(channelID, ""))
  1088. if err != nil {
  1089. return
  1090. }
  1091. err = unmarshal(response, &st)
  1092. return
  1093. }
  1094. // ChannelMessageDelete deletes a message from the Channel.
  1095. func (s *Session) ChannelMessageDelete(channelID, messageID string) (err error) {
  1096. _, err = s.RequestWithBucketID("DELETE", EndpointChannelMessage(channelID, messageID), nil, EndpointChannelMessage(channelID, ""))
  1097. return
  1098. }
  1099. // ChannelMessagesBulkDelete bulk deletes the messages from the channel for the provided messageIDs.
  1100. // If only one messageID is in the slice call channelMessageDelete funciton.
  1101. // If the slice is empty do nothing.
  1102. // channelID : The ID of the channel for the messages to delete.
  1103. // messages : The IDs of the messages to be deleted. A slice of string IDs. A maximum of 100 messages.
  1104. func (s *Session) ChannelMessagesBulkDelete(channelID string, messages []string) (err error) {
  1105. if len(messages) == 0 {
  1106. return
  1107. }
  1108. if len(messages) == 1 {
  1109. err = s.ChannelMessageDelete(channelID, messages[0])
  1110. return
  1111. }
  1112. if len(messages) > 100 {
  1113. messages = messages[:100]
  1114. }
  1115. data := struct {
  1116. Messages []string `json:"messages"`
  1117. }{messages}
  1118. _, err = s.RequestWithBucketID("POST", EndpointChannelMessagesBulkDelete(channelID), data, EndpointChannelMessagesBulkDelete(channelID))
  1119. return
  1120. }
  1121. // ChannelMessagePin pins a message within a given channel.
  1122. // channelID: The ID of a channel.
  1123. // messageID: The ID of a message.
  1124. func (s *Session) ChannelMessagePin(channelID, messageID string) (err error) {
  1125. _, err = s.RequestWithBucketID("PUT", EndpointChannelMessagePin(channelID, messageID), nil, EndpointChannelMessagePin(channelID, ""))
  1126. return
  1127. }
  1128. // ChannelMessageUnpin unpins a message within a given channel.
  1129. // channelID: The ID of a channel.
  1130. // messageID: The ID of a message.
  1131. func (s *Session) ChannelMessageUnpin(channelID, messageID string) (err error) {
  1132. _, err = s.RequestWithBucketID("DELETE", EndpointChannelMessagePin(channelID, messageID), nil, EndpointChannelMessagePin(channelID, ""))
  1133. return
  1134. }
  1135. // ChannelMessagesPinned returns an array of Message structures for pinned messages
  1136. // within a given channel
  1137. // channelID : The ID of a Channel.
  1138. func (s *Session) ChannelMessagesPinned(channelID string) (st []*Message, err error) {
  1139. body, err := s.RequestWithBucketID("GET", EndpointChannelMessagesPins(channelID), nil, EndpointChannelMessagesPins(channelID))
  1140. if err != nil {
  1141. return
  1142. }
  1143. err = unmarshal(body, &st)
  1144. return
  1145. }
  1146. // ChannelFileSend sends a file to the given channel.
  1147. // channelID : The ID of a Channel.
  1148. // name: The name of the file.
  1149. // io.Reader : A reader for the file contents.
  1150. func (s *Session) ChannelFileSend(channelID, name string, r io.Reader) (st *Message, err error) {
  1151. return s.ChannelFileSendWithMessage(channelID, "", name, r)
  1152. }
  1153. // ChannelFileSendWithMessage sends a file to the given channel with an message.
  1154. // channelID : The ID of a Channel.
  1155. // content: Optional Message content.
  1156. // name: The name of the file.
  1157. // io.Reader : A reader for the file contents.
  1158. func (s *Session) ChannelFileSendWithMessage(channelID, content string, name string, r io.Reader) (st *Message, err error) {
  1159. body := &bytes.Buffer{}
  1160. bodywriter := multipart.NewWriter(body)
  1161. if len(content) != 0 {
  1162. if err := bodywriter.WriteField("content", content); err != nil {
  1163. return nil, err
  1164. }
  1165. }
  1166. writer, err := bodywriter.CreateFormFile("file", name)
  1167. if err != nil {
  1168. return nil, err
  1169. }
  1170. _, err = io.Copy(writer, r)
  1171. if err != nil {
  1172. return
  1173. }
  1174. err = bodywriter.Close()
  1175. if err != nil {
  1176. return
  1177. }
  1178. response, err := s.request("POST", EndpointChannelMessages(channelID), bodywriter.FormDataContentType(), body.Bytes(), EndpointChannelMessages(channelID), 0)
  1179. if err != nil {
  1180. return
  1181. }
  1182. err = unmarshal(response, &st)
  1183. return
  1184. }
  1185. // ChannelInvites returns an array of Invite structures for the given channel
  1186. // channelID : The ID of a Channel
  1187. func (s *Session) ChannelInvites(channelID string) (st []*Invite, err error) {
  1188. body, err := s.RequestWithBucketID("GET", EndpointChannelInvites(channelID), nil, EndpointChannelInvites(channelID))
  1189. if err != nil {
  1190. return
  1191. }
  1192. err = unmarshal(body, &st)
  1193. return
  1194. }
  1195. // ChannelInviteCreate creates a new invite for the given channel.
  1196. // channelID : The ID of a Channel
  1197. // i : An Invite struct with the values MaxAge, MaxUses, Temporary,
  1198. // and XkcdPass defined.
  1199. func (s *Session) ChannelInviteCreate(channelID string, i Invite) (st *Invite, err error) {
  1200. data := struct {
  1201. MaxAge int `json:"max_age"`
  1202. MaxUses int `json:"max_uses"`
  1203. Temporary bool `json:"temporary"`
  1204. XKCDPass string `json:"xkcdpass"`
  1205. }{i.MaxAge, i.MaxUses, i.Temporary, i.XkcdPass}
  1206. body, err := s.RequestWithBucketID("POST", EndpointChannelInvites(channelID), data, EndpointChannelInvites(channelID))
  1207. if err != nil {
  1208. return
  1209. }
  1210. err = unmarshal(body, &st)
  1211. return
  1212. }
  1213. // ChannelPermissionSet creates a Permission Override for the given channel.
  1214. // NOTE: This func name may changed. Using Set instead of Create because
  1215. // you can both create a new override or update an override with this function.
  1216. func (s *Session) ChannelPermissionSet(channelID, targetID, targetType string, allow, deny int) (err error) {
  1217. data := struct {
  1218. ID string `json:"id"`
  1219. Type string `json:"type"`
  1220. Allow int `json:"allow"`
  1221. Deny int `json:"deny"`
  1222. }{targetID, targetType, allow, deny}
  1223. _, err = s.RequestWithBucketID("PUT", EndpointChannelPermission(channelID, targetID), data, EndpointChannelPermission(channelID, ""))
  1224. return
  1225. }
  1226. // ChannelPermissionDelete deletes a specific permission override for the given channel.
  1227. // NOTE: Name of this func may change.
  1228. func (s *Session) ChannelPermissionDelete(channelID, targetID string) (err error) {
  1229. _, err = s.RequestWithBucketID("DELETE", EndpointChannelPermission(channelID, targetID), nil, EndpointChannelPermission(channelID, ""))
  1230. return
  1231. }
  1232. // ------------------------------------------------------------------------------------------------
  1233. // Functions specific to Discord Invites
  1234. // ------------------------------------------------------------------------------------------------
  1235. // Invite returns an Invite structure of the given invite
  1236. // inviteID : The invite code (or maybe xkcdpass?)
  1237. func (s *Session) Invite(inviteID string) (st *Invite, err error) {
  1238. body, err := s.RequestWithBucketID("GET", EndpointInvite(inviteID), nil, EndpointInvite(""))
  1239. if err != nil {
  1240. return
  1241. }
  1242. err = unmarshal(body, &st)
  1243. return
  1244. }
  1245. // InviteDelete deletes an existing invite
  1246. // inviteID : the code (or maybe xkcdpass?) of an invite
  1247. func (s *Session) InviteDelete(inviteID string) (st *Invite, err error) {
  1248. body, err := s.RequestWithBucketID("DELETE", EndpointInvite(inviteID), nil, EndpointInvite(""))
  1249. if err != nil {
  1250. return
  1251. }
  1252. err = unmarshal(body, &st)
  1253. return
  1254. }
  1255. // InviteAccept accepts an Invite to a Guild or Channel
  1256. // inviteID : The invite code (or maybe xkcdpass?)
  1257. func (s *Session) InviteAccept(inviteID string) (st *Invite, err error) {
  1258. body, err := s.RequestWithBucketID("POST", EndpointInvite(inviteID), nil, EndpointInvite(""))
  1259. if err != nil {
  1260. return
  1261. }
  1262. err = unmarshal(body, &st)
  1263. return
  1264. }
  1265. // ------------------------------------------------------------------------------------------------
  1266. // Functions specific to Discord Voice
  1267. // ------------------------------------------------------------------------------------------------
  1268. // VoiceRegions returns the voice server regions
  1269. func (s *Session) VoiceRegions() (st []*VoiceRegion, err error) {
  1270. body, err := s.RequestWithBucketID("GET", EndpointVoiceRegions, nil, EndpointVoiceRegions)
  1271. if err != nil {
  1272. return
  1273. }
  1274. err = unmarshal(body, &st)
  1275. return
  1276. }
  1277. // VoiceICE returns the voice server ICE information
  1278. func (s *Session) VoiceICE() (st *VoiceICE, err error) {
  1279. body, err := s.RequestWithBucketID("GET", EndpointVoiceIce, nil, EndpointVoiceIce)
  1280. if err != nil {
  1281. return
  1282. }
  1283. err = unmarshal(body, &st)
  1284. return
  1285. }
  1286. // ------------------------------------------------------------------------------------------------
  1287. // Functions specific to Discord Websockets
  1288. // ------------------------------------------------------------------------------------------------
  1289. // Gateway returns the a websocket Gateway address
  1290. func (s *Session) Gateway() (gateway string, err error) {
  1291. response, err := s.RequestWithBucketID("GET", EndpointGateway, nil, EndpointGateway)
  1292. if err != nil {
  1293. return
  1294. }
  1295. temp := struct {
  1296. URL string `json:"url"`
  1297. }{}
  1298. err = unmarshal(response, &temp)
  1299. if err != nil {
  1300. return
  1301. }
  1302. gateway = temp.URL
  1303. // Ensure the gateway always has a trailing slash.
  1304. // MacOS will fail to connect if we add query params without a trailing slash on the base domain.
  1305. if !strings.HasSuffix(gateway, "/") {
  1306. gateway += "/"
  1307. }
  1308. return
  1309. }
  1310. // Functions specific to Webhooks
  1311. // WebhookCreate returns a new Webhook.
  1312. // channelID: The ID of a Channel.
  1313. // name : The name of the webhook.
  1314. // avatar : The avatar of the webhook.
  1315. func (s *Session) WebhookCreate(channelID, name, avatar string) (st *Webhook, err error) {
  1316. data := struct {
  1317. Name string `json:"name"`
  1318. Avatar string `json:"avatar,omitempty"`
  1319. }{name, avatar}
  1320. body, err := s.RequestWithBucketID("POST", EndpointChannelWebhooks(channelID), data, EndpointChannelWebhooks(channelID))
  1321. if err != nil {
  1322. return
  1323. }
  1324. err = unmarshal(body, &st)
  1325. return
  1326. }
  1327. // ChannelWebhooks returns all webhooks for a given channel.
  1328. // channelID: The ID of a channel.
  1329. func (s *Session) ChannelWebhooks(channelID string) (st []*Webhook, err error) {
  1330. body, err := s.RequestWithBucketID("GET", EndpointChannelWebhooks(channelID), nil, EndpointChannelWebhooks(channelID))
  1331. if err != nil {
  1332. return
  1333. }
  1334. err = unmarshal(body, &st)
  1335. return
  1336. }
  1337. // GuildWebhooks returns all webhooks for a given guild.
  1338. // guildID: The ID of a Guild.
  1339. func (s *Session) GuildWebhooks(guildID string) (st []*Webhook, err error) {
  1340. body, err := s.RequestWithBucketID("GET", EndpointGuildWebhooks(guildID), nil, EndpointGuildWebhooks(guildID))
  1341. if err != nil {
  1342. return
  1343. }
  1344. err = unmarshal(body, &st)
  1345. return
  1346. }
  1347. // Webhook returns a webhook for a given ID
  1348. // webhookID: The ID of a webhook.
  1349. func (s *Session) Webhook(webhookID string) (st *Webhook, err error) {
  1350. body, err := s.RequestWithBucketID("GET", EndpointWebhook(webhookID), nil, EndpointWebhooks)
  1351. if err != nil {
  1352. return
  1353. }
  1354. err = unmarshal(body, &st)
  1355. return
  1356. }
  1357. // WebhookWithToken returns a webhook for a given ID
  1358. // webhookID: The ID of a webhook.
  1359. // token : The auth token for the webhook.
  1360. func (s *Session) WebhookWithToken(webhookID, token string) (st *Webhook, err error) {
  1361. body, err := s.RequestWithBucketID("GET", EndpointWebhookToken(webhookID, token), nil, EndpointWebhookToken("", ""))
  1362. if err != nil {
  1363. return
  1364. }
  1365. err = unmarshal(body, &st)
  1366. return
  1367. }
  1368. // WebhookEdit updates an existing Webhook.
  1369. // webhookID: The ID of a webhook.
  1370. // name : The name of the webhook.
  1371. // avatar : The avatar of the webhook.
  1372. func (s *Session) WebhookEdit(webhookID, name, avatar string) (st *Role, err error) {
  1373. data := struct {
  1374. Name string `json:"name,omitempty"`
  1375. Avatar string `json:"avatar,omitempty"`
  1376. }{name, avatar}
  1377. body, err := s.RequestWithBucketID("PATCH", EndpointWebhook(webhookID), data, EndpointWebhooks)
  1378. if err != nil {
  1379. return
  1380. }
  1381. err = unmarshal(body, &st)
  1382. return
  1383. }
  1384. // WebhookEditWithToken updates an existing Webhook with an auth token.
  1385. // webhookID: The ID of a webhook.
  1386. // token : The auth token for the webhook.
  1387. // name : The name of the webhook.
  1388. // avatar : The avatar of the webhook.
  1389. func (s *Session) WebhookEditWithToken(webhookID, token, name, avatar string) (st *Role, err error) {
  1390. data := struct {
  1391. Name string `json:"name,omitempty"`
  1392. Avatar string `json:"avatar,omitempty"`
  1393. }{name, avatar}
  1394. body, err := s.RequestWithBucketID("PATCH", EndpointWebhookToken(webhookID, token), data, EndpointWebhookToken("", ""))
  1395. if err != nil {
  1396. return
  1397. }
  1398. err = unmarshal(body, &st)
  1399. return
  1400. }
  1401. // WebhookDelete deletes a webhook for a given ID
  1402. // webhookID: The ID of a webhook.
  1403. func (s *Session) WebhookDelete(webhookID string) (st *Webhook, err error) {
  1404. body, err := s.RequestWithBucketID("DELETE", EndpointWebhook(webhookID), nil, EndpointWebhooks)
  1405. if err != nil {
  1406. return
  1407. }
  1408. err = unmarshal(body, &st)
  1409. return
  1410. }
  1411. // WebhookDeleteWithToken deletes a webhook for a given ID with an auth token.
  1412. // webhookID: The ID of a webhook.
  1413. // token : The auth token for the webhook.
  1414. func (s *Session) WebhookDeleteWithToken(webhookID, token string) (st *Webhook, err error) {
  1415. body, err := s.RequestWithBucketID("DELETE", EndpointWebhookToken(webhookID, token), nil, EndpointWebhookToken("", ""))
  1416. if err != nil {
  1417. return
  1418. }
  1419. err = unmarshal(body, &st)
  1420. return
  1421. }
  1422. // WebhookExecute executes a webhook.
  1423. // webhookID: The ID of a webhook.
  1424. // token : The auth token for the webhook
  1425. func (s *Session) WebhookExecute(webhookID, token string, wait bool, data *WebhookParams) (err error) {
  1426. uri := EndpointWebhookToken(webhookID, token)
  1427. if wait {
  1428. uri += "?wait=true"
  1429. }
  1430. _, err = s.RequestWithBucketID("POST", uri, data, EndpointWebhookToken("", ""))
  1431. return
  1432. }
  1433. // MessageReactionAdd creates an emoji reaction to a message.
  1434. // channelID : The channel ID.
  1435. // messageID : The message ID.
  1436. // emojiID : Either the unicode emoji for the reaction, or a guild emoji identifier.
  1437. func (s *Session) MessageReactionAdd(channelID, messageID, emojiID string) error {
  1438. _, err := s.RequestWithBucketID("PUT", EndpointMessageReaction(channelID, messageID, emojiID, "@me"), nil, EndpointMessageReaction(channelID, "", "", ""))
  1439. return err
  1440. }
  1441. // MessageReactionRemove deletes an emoji reaction to a message.
  1442. // channelID : The channel ID.
  1443. // messageID : The message ID.
  1444. // emojiID : Either the unicode emoji for the reaction, or a guild emoji identifier.
  1445. // userID : @me or ID of the user to delete the reaction for.
  1446. func (s *Session) MessageReactionRemove(channelID, messageID, emojiID, userID string) error {
  1447. _, err := s.RequestWithBucketID("DELETE", EndpointMessageReaction(channelID, messageID, emojiID, userID), nil, EndpointMessageReaction(channelID, "", "", ""))
  1448. return err
  1449. }
  1450. // MessageReactions gets all the users reactions for a specific emoji.
  1451. // channelID : The channel ID.
  1452. // messageID : The message ID.
  1453. // emojiID : Either the unicode emoji for the reaction, or a guild emoji identifier.
  1454. // limit : max number of users to return (max 100)
  1455. func (s *Session) MessageReactions(channelID, messageID, emojiID string, limit int) (st []*User, err error) {
  1456. uri := EndpointMessageReactions(channelID, messageID, emojiID)
  1457. v := url.Values{}
  1458. if limit > 0 {
  1459. v.Set("limit", strconv.Itoa(limit))
  1460. }
  1461. if len(v) > 0 {
  1462. uri = fmt.Sprintf("%s?%s", uri, v.Encode())
  1463. }
  1464. body, err := s.RequestWithBucketID("GET", uri, nil, EndpointMessageReaction(channelID, "", "", ""))
  1465. if err != nil {
  1466. return
  1467. }
  1468. err = unmarshal(body, &st)
  1469. return
  1470. }
  1471. // ------------------------------------------------------------------------------------------------
  1472. // Functions specific to Discord Relationships (Friends list)
  1473. // ------------------------------------------------------------------------------------------------
  1474. // RelationshipsGet returns an array of all the relationships of the user.
  1475. func (s *Session) RelationshipsGet() (r []*Relationship, err error) {
  1476. body, err := s.RequestWithBucketID("GET", EndpointRelationships(), nil, EndpointRelationships())
  1477. if err != nil {
  1478. return
  1479. }
  1480. err = unmarshal(body, &r)
  1481. return
  1482. }
  1483. // relationshipCreate creates a new relationship. (I.e. send or accept a friend request, block a user.)
  1484. // relationshipType : 1 = friend, 2 = blocked, 3 = incoming friend req, 4 = sent friend req
  1485. func (s *Session) relationshipCreate(userID string, relationshipType int) (err error) {
  1486. data := struct {
  1487. Type int `json:"type"`
  1488. }{relationshipType}
  1489. _, err = s.RequestWithBucketID("PUT", EndpointRelationship(userID), data, EndpointRelationships())
  1490. return
  1491. }
  1492. // RelationshipFriendRequestSend sends a friend request to a user.
  1493. // userID: ID of the user.
  1494. func (s *Session) RelationshipFriendRequestSend(userID string) (err error) {
  1495. err = s.relationshipCreate(userID, 4)
  1496. return
  1497. }
  1498. // RelationshipFriendRequestAccept accepts a friend request from a user.
  1499. // userID: ID of the user.
  1500. func (s *Session) RelationshipFriendRequestAccept(userID string) (err error) {
  1501. err = s.relationshipCreate(userID, 1)
  1502. return
  1503. }
  1504. // RelationshipUserBlock blocks a user.
  1505. // userID: ID of the user.
  1506. func (s *Session) RelationshipUserBlock(userID string) (err error) {
  1507. err = s.relationshipCreate(userID, 2)
  1508. return
  1509. }
  1510. // RelationshipDelete removes the relationship with a user.
  1511. // userID: ID of the user.
  1512. func (s *Session) RelationshipDelete(userID string) (err error) {
  1513. _, err = s.RequestWithBucketID("DELETE", EndpointRelationship(userID), nil, EndpointRelationships())
  1514. return
  1515. }
  1516. // RelationshipsMutualGet returns an array of all the users both @me and the given user is friends with.
  1517. // userID: ID of the user.
  1518. func (s *Session) RelationshipsMutualGet(userID string) (mf []*User, err error) {
  1519. body, err := s.RequestWithBucketID("GET", EndpointRelationshipsMutual(userID), nil, EndpointRelationshipsMutual(userID))
  1520. if err != nil {
  1521. return
  1522. }
  1523. err = unmarshal(body, &mf)
  1524. return
  1525. }