Liking cljdoc? Tell your friends :D
Clojure only.

discljord.messaging

Contains functions for communicating with Discord, sending messages, and recieving data.

All endpoint-based functions in this namespace return promises of a sort. The returned value is not a Clojure promise however, but is an implementation of [[IDeref]] which also functions as a core.async channel. This means that in addition to [[deref]]ing the return values, they may also have a parking take performed on them for better concurrency.

Contains functions for communicating with Discord, sending messages, and recieving data.

All endpoint-based functions in this namespace return promises of a sort. The
returned value is not a Clojure promise however, but is an implementation
of [[IDeref]] which also functions as a `core.async` channel. This means that
in addition to [[deref]]ing the return values, they may also have a parking
take performed on them for better concurrency.
raw docstring

add-channel-pinned-message!clj

(add-channel-pinned-message! conn
                             channel-id
                             message-id
                             &
                             {:as opts :keys [user-agent audit-reason]})

Pins the given message to the channel. Returns a promise containing a boolean of if it succeeded.

Pins the given message to the channel. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

add-guild-member!clj

(add-guild-member! conn
                   guild-id
                   user-id
                   access-token
                   &
                   {:as opts
                    :keys [nick roles mute deaf user-agent audit-reason]})

NOT INTENDED FOR BOT USE. Adds a user to a guild. Requires an access token. Returns a promise containing the keyword :already-member if the user is already a member, or the guild member object.

NOT INTENDED FOR BOT USE. Adds a user to a guild. Requires an access token. Returns a promise containing the keyword :already-member if the user is already a member, or the guild member object.
sourceraw docstring

add-guild-member-role!clj

(add-guild-member-role! conn
                        guild-id
                        user-id
                        role-id
                        &
                        {:as opts :keys [user-agent audit-reason]})

Adds the given role to the user. Returns a promise containing a boolean of if it succeeded.

Adds the given role to the user. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

begin-guild-prune!clj

(begin-guild-prune! conn
                    guild-id
                    days
                    compute-prune-count
                    &
                    {:as opts :keys [user-agent audit-reason]})

Starts a guild prune. Returns a promise containing nil if compute-prune-count is false, otherwise the number of users to be prouned.

Starts a guild prune. Returns a promise containing nil if compute-prune-count is false, otherwise the number of users to be prouned.
sourceraw docstring

bulk-delete-messages!clj

(bulk-delete-messages! conn
                       channel-id
                       messages
                       &
                       {:as opts :keys [user-agent audit-reason]})

Deletes all the messages whose id's are in the passed vector. Returns a promise containing a boolean of if it succeeded.

Deletes all the messages whose id's are in the passed vector. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

bulk-overwrite-global-application-commands!clj

(bulk-overwrite-global-application-commands! conn
                                             application-id
                                             commands
                                             &
                                             {:as opts
                                              :keys [user-agent audit-reason]})

Overwrites all global slash commands with the provided ones.

If a command with a given name doesn't exist, creates that command. Returns a promise containing the updated application command objects.

Overwrites all global slash commands with the provided ones.

If a command with a given name doesn't exist, creates that command.
Returns a promise containing the updated application command objects.
sourceraw docstring

bulk-overwrite-guild-application-commands!clj

(bulk-overwrite-guild-application-commands! conn
                                            application-id
                                            guild-id
                                            commands
                                            &
                                            {:as opts
                                             :keys [user-agent audit-reason]})

Overwrites all guild slash commands with the provided ones.

If a command with a given name doesn't exist, creates that command. Returns a promise containing the updated application command objects.

Overwrites all guild slash commands with the provided ones.

If a command with a given name doesn't exist, creates that command.
Returns a promise containing the updated application command objects.
sourceraw docstring

create-channel-invite!clj

(create-channel-invite!
  conn
  channel-id
  &
  {:as opts :keys [max-age max-uses temporary unique user-agent audit-reason]})

Returns a promise containing a new invite object.

Returns a promise containing a new invite object.
sourceraw docstring

create-dm!clj

(create-dm! conn user-id & {:as opts :keys [user-agent audit-reason]})

Returns a promise containing a DM channel object with the given user.

Returns a promise containing a DM channel object with the given user.
sourceraw docstring

create-followup-message!clj

(create-followup-message! conn
                          application-id
                          interaction-token
                          &
                          {:as opts
                           :keys [content file stream embeds username avatar-url
                                  tts allowed-mentions user-agent
                                  audit-reason]})

Creates a followup message for the given interaction.

Returns a promise containing the message that was created.

Creates a followup message for the given interaction.

Returns a promise containing the message that was created.
sourceraw docstring

create-global-application-command!clj

(create-global-application-command! conn
                                    application-id
                                    name
                                    description
                                    &
                                    {:as opts
                                     :keys [ms.command/options
                                            ms.command/default_permission
                                            user-agent audit-reason]})

Creates or updates a global slash command.

New global commands will be available in all guilds after 1 hour. Returns a promise containing the new application command object.

Creates or updates a global slash command.

New global commands will be available in all guilds after 1 hour.
Returns a promise containing the new application command object.
sourceraw docstring

create-group-dm!clj

(create-group-dm! conn
                  access-tokens
                  nicks
                  &
                  {:as opts :keys [user-agent audit-reason]})

NOT INTENDED FOR BOT USE. Returns a promise containing a DM channel object.

NOT INTENDED FOR BOT USE. Returns a promise containing a DM channel object.
sourceraw docstring

create-guild!clj

(create-guild! conn
               name
               region
               icon
               verification-level
               default-message-notifications
               explicit-content-filter
               role-objects
               channels
               &
               {:as opts :keys [user-agent audit-reason]})

Returns a promise containing the created guild object.

Returns a promise containing the created guild object.
sourceraw docstring

create-guild-application-command!clj

(create-guild-application-command! conn
                                   application-id
                                   guild-id
                                   name
                                   description
                                   &
                                   {:as opts
                                    :keys [ms.command/options
                                           ms.command/default_permission
                                           user-agent audit-reason]})

Creates or updates a guild slash command.

Returns a promise containing the new application command object.

Creates or updates a guild slash command.

Returns a promise containing the new application command object.
sourceraw docstring

create-guild-ban!clj

(create-guild-ban! conn
                   guild-id
                   user-id
                   &
                   {:as opts
                    :keys [delete-message-days reason user-agent audit-reason]})

Bans a user. Returns a promise containing a boolean of if it succeeded.

Bans a user. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

create-guild-channel!clj

(create-guild-channel!
  conn
  guild-id
  name
  &
  {:as opts
   :keys [ms.channel/type topic bitrate user-limit rate-limit-per-user position
          permission-overwrites parent-id nsfw user-agent audit-reason]})

Returns a promise containing the new channel object.

Returns a promise containing the new channel object.
sourceraw docstring

create-guild-emoji!clj

(create-guild-emoji! conn
                     guild-id
                     name
                     image
                     roles
                     &
                     {:as opts :keys [user-agent audit-reason]})

Creates a new guild emoji. Returns a promise containing the new emoji object.

Creates a new guild emoji. Returns a promise containing the new emoji object.
sourceraw docstring

create-guild-integration!clj

(create-guild-integration! conn
                           guild-id
                           type
                           id
                           &
                           {:as opts :keys [user-agent audit-reason]})

Creates a new integration in the guild. Returns a promise containing a boolean of if it succeeded.

Creates a new integration in the guild. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

create-guild-role!clj

(create-guild-role! conn
                    guild-id
                    &
                    {:as opts
                     :keys [name permissions color hoist mentionable user-agent
                            audit-reason]})

Returns a promise containing the created role.

Returns a promise containing the created role.
sourceraw docstring

create-interaction-response!clj

(create-interaction-response! conn
                              interaction-id
                              interaction-token
                              type
                              &
                              {:as opts
                               :keys [ms.interaction-response/data file stream
                                      user-agent audit-reason]})

Sends a response to an interaction event.

Returns a promise containing a boolean of if it succeeded.

Sends a response to an interaction event.

Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

create-message!clj

(create-message! conn
                 channel-id
                 &
                 {:as opts
                  :keys [content tts nonce embed file allowed-mentions
                         attachments stream message-reference user-agent
                         audit-reason]})

Sends a message on the channel. Returns a promise containing the message object.

Keyword Arguments: :user-agent changes the User-Agent header sent to Discord. :tts is a boolean, defaulting to false, which tells Discord to read your message out loud. :file is a java.io.File object specifying a file for Discord to attach to the message. :attachments is a collection of file-like objects to attach to the message. :stream is a map that has a :content of a java.io.InputStream and a :filename of the filename to attach to the message. :embed is a map specifying the embed format for the message (See Discord API)

Sends a message on the channel. Returns a promise containing the message object.

Keyword Arguments:
:user-agent changes the User-Agent header sent to Discord.
:tts is a boolean, defaulting to false, which tells Discord to read
     your message out loud.
:file is a java.io.File object specifying a file for Discord to attach to the message.
:attachments is a collection of file-like objects to attach to the message.
:stream is a map that has a :content of a java.io.InputStream and a :filename of the filename to attach to the message.
:embed is a map specifying the embed format for the message (See Discord API)
sourceraw docstring

create-reaction!clj

(create-reaction! conn
                  channel-id
                  message-id
                  emoji
                  &
                  {:as opts :keys [user-agent audit-reason]})

Creates a new reaction on the message with the given emoji (either unicode or "name:id" for a custom emoji). Returns a promise containing a boolean, telling you if it succeeded.

Creates a new reaction on the message with the given emoji (either unicode or "name:id" for a custom emoji). Returns a promise containing a boolean, telling you if it succeeded.
sourceraw docstring

create-webhook!clj

(create-webhook! conn
                 channel-id
                 name
                 &
                 {:as opts :keys [avatar user-agent audit-reason]})

Returns a promise containing the new webhook object.

Returns a promise containing the new webhook object.
sourceraw docstring

defendpointcljmacro

(defendpoint endpoint-name major-var-type doc-str params opts)

Creates a new non-blocking function for a discord endpoint.

  • endpoint-name: the name of the edpoint function. must end with an '!'
  • major-var-type: the spec-name of the major variable used in this endpoint, if any. If there is none, nil should be used.
  • doc-str: Documentation for the endpoint function.
  • params: Required parameters for this endpoint. If the major variable is the first parameter, it need not be included here. The macro will attempt to find a spec for each parameter. If the parameter is an unqualified symbol, :discljord.messaging.specs/param will be used, otherwise the associated namespace. Aliases that do not contain dots . can be used as namespace segments. Some examples for spec resolution:
    • baz => :discljord.messaging.specs/baz
    • foo.bar/baz => :foo.bar/baz
    • foo.bar/baz and foo is an alias for quz.foo in the current namespace => :quz.foo.bar/baz
    • foo.bar/baz and foo.bar is an alias for lorem.ipsum in the current namespace => :foo.bar/baz (aliases with dots in them can't be used)
  • opts: Optional parameters for this endpoint. Spec resolution works exactly like for params.
Creates a new non-blocking function for a discord endpoint.

- `endpoint-name`: the name of the edpoint function. must end with an '!'
- `major-var-type`: the spec-name of the major variable used in this endpoint, if any. If there is none, `nil` should be used.
- `doc-str`: Documentation for the endpoint function.
- `params`: Required parameters for this endpoint. If the major variable is the first parameter, it need not be included here.
  The macro will attempt to find a spec for each parameter. If the parameter is an unqualified symbol, `:discljord.messaging.specs/param` will be used,
  otherwise the associated namespace. Aliases that do not contain dots `.` can be used as namespace segments. Some examples for spec resolution:
  - `baz` => `:discljord.messaging.specs/baz`
  - `foo.bar/baz` => `:foo.bar/baz`
  - `foo.bar/baz` and `foo` is an alias for `quz.foo` in the current namespace => `:quz.foo.bar/baz`
  - `foo.bar/baz` and `foo.bar` is an alias for `lorem.ipsum` in the current namespace => `:foo.bar/baz` (aliases with dots in them can't be used)
- `opts`: Optional parameters for this endpoint. Spec resolution works exactly like for `params`.
sourceraw docstring

delete-all-reactions!clj

(delete-all-reactions! conn
                       channel-id
                       message-id
                       &
                       {:as opts :keys [user-agent audit-reason]})

Deletes all reactions on a message. Returns a promise containing a boolean of if it succeeded.

Deletes all reactions on a message. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

delete-all-reactions-for-emoji!clj

(delete-all-reactions-for-emoji! conn
                                 channel-id
                                 message-id
                                 emoji
                                 &
                                 {:as opts :keys [user-agent audit-reason]})

Deletes all reactions of a particular emoji on a message. Returns a promise containing a boolean of if it succeeded.

Deletes all reactions of a particular emoji on a message. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

delete-channel!clj

(delete-channel! conn
                 channel-id
                 &
                 {:as opts :keys [user-agent user-agent audit-reason]})

Deletes a channel. Returns a promise containing the deleted channel object.

Deletes a channel. Returns a promise containing the deleted channel object.
sourceraw docstring

delete-channel-permission!clj

(delete-channel-permission! conn
                            channel-id
                            overwrite-id
                            &
                            {:as opts :keys [user-agent audit-reason]})

Deletes a permission override in a channel. Returns a promise containing a boolean of if it succeeded.

Deletes a permission override in a channel. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

delete-followup-message!clj

(delete-followup-message! conn
                          interation-token
                          application-id
                          interaction-token
                          message-id
                          &
                          {:as opts :keys [user-agent audit-reason]})

Deletes a followup message to an interaction by its id.

Returns a promise containing a boolean of if it succeeded.

Deletes a followup message to an interaction by its id.

Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

delete-global-application-command!clj

(delete-global-application-command! conn
                                    application-id
                                    command-id
                                    &
                                    {:as opts :keys [user-agent audit-reason]})

Deletes an existing global slash command by its id.

Returns a promise containing a boolean of if it succeeded.

Deletes an existing global slash command by its id.

Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

delete-guild!clj

(delete-guild! conn guild-id & {:as opts :keys [user-agent audit-reason]})

Deletes a guild if the bot is the owner. Returns a promise containing a boolean of if it succeeded.

Deletes a guild if the bot is the owner. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

delete-guild-application-command!clj

(delete-guild-application-command! conn
                                   application-id
                                   guild-id
                                   command-id
                                   &
                                   {:as opts :keys [user-agent audit-reason]})

Deletes an existing guild slash command by its id.

Returns a promise containing a boolean of if it succeeded.

Deletes an existing guild slash command by its id.

Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

delete-guild-emoji!clj

(delete-guild-emoji! conn
                     guild-id
                     emoji
                     &
                     {:as opts :keys [user-agent audit-reason]})

Deletes an emoji from the guild. Returns a promise containing a boolean of if it succeeded.

Deletes an emoji from the guild. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

delete-guild-integration!clj

(delete-guild-integration! conn
                           guild-id
                           integration-id
                           &
                           {:as opts :keys [user-agent audit-reason]})

Deletes a guild integration. Returns a promise containing a boolean of if it succeeded.

Deletes a guild integration. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

delete-guild-role!clj

(delete-guild-role! conn
                    guild-id
                    role-id
                    &
                    {:as opts :keys [user-agent audit-reason]})

Deletes a guild role. Returns a promise containing a boolean of if it succeeded.

Deletes a guild role. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

delete-invite!clj

(delete-invite! conn invite-code & {:as opts :keys [user-agent audit-reason]})

Deletes the invite. Returns a promise containing the deleted invite.

Deletes the invite. Returns a promise containing the deleted invite.
sourceraw docstring

delete-message!clj

(delete-message! conn
                 channel-id
                 message-id
                 &
                 {:as opts :keys [user-agent audit-reason]})

Deletes the given message. Returns a promise containing a boolean of if it succeeded.

Deletes the given message. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

delete-original-interaction-response!clj

(delete-original-interaction-response! conn
                                       application-id
                                       interaction-token
                                       &
                                       {:as opts
                                        :keys [user-agent audit-reason]})

Deletes the initial response to the given interaction.

Returns a promise containing a boolean of if it succeeded.

Deletes the initial response to the given interaction.

Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

delete-own-reaction!clj

(delete-own-reaction! conn
                      channel-id
                      message-id
                      emoji
                      &
                      {:as opts :keys [user-agent audit-reason]})

Deletes your reaction on the messasge with the given emoji (either unicode or "name:id" for a custom emoji). Returns a promise containing a boolean, telling you if it succeeded.

Deletes your reaction on the messasge with the given emoji (either unicode or "name:id" for a custom emoji). Returns a promise containing a boolean, telling you if it succeeded.
sourceraw docstring

delete-pinned-channel-message!clj

(delete-pinned-channel-message! conn
                                channel-id
                                message-id
                                &
                                {:as opts :keys [user-agent audit-reason]})

Removes a message from the pinned list in the channel. Returns a promise containing a boolean of if it succeeded.

Removes a message from the pinned list in the channel. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

delete-user-reaction!clj

(delete-user-reaction! conn
                       channel-id
                       message-id
                       emoji
                       user-id
                       &
                       {:as opts :keys [user-agent audit-reason]})

Deletes a given user's reaction to a message with the given emoji (either unicode or "name:id" for a custom emoji). Returns a promise containing a boolean, telling you if it succeeded.

Deletes a given user's reaction to a message with the given emoji (either unicode or "name:id" for a custom emoji). Returns a promise containing a boolean, telling you if it succeeded.
sourceraw docstring

delete-webhook!clj

(delete-webhook! conn webhook-id & {:as opts :keys [user-agent audit-reason]})

Deletes the webhook. Returns a promise containing a boolean of if it succeeded.

Deletes the webhook. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

delete-webhook-message!clj

(delete-webhook-message! conn
                         webhook-id
                         webhook-token
                         message-id
                         &
                         {:as opts :keys [user-agent audit-reason]})

Deletes a messages that was sent from the given webhook.

Returns a promise containing a boolean of if it succeeded.

Deletes a messages that was sent from the given webhook.

Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

delete-webhook-with-token!clj

(delete-webhook-with-token! conn
                            webhook-id
                            webhook-token
                            &
                            {:as opts :keys [user-agent audit-reason]})

Deletes the webhook, but does not require authentication. Returns a promise containing a boolean of if it succeeded.

Deletes the webhook, but does not require authentication. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

edit-application-command-permissions!clj

(edit-application-command-permissions! conn
                                       application-id
                                       guild-id
                                       command-id
                                       permissions
                                       &
                                       {:as opts
                                        :keys [user-agent audit-reason]})

Sets the permission settings for the given command in the guild.

Returns a promise containing the updated permission settings in a map with some additional information.

Sets the permission settings for the given command in the guild.

Returns a promise containing the updated permission settings in a map with some additional information.
sourceraw docstring

edit-channel-permissions!clj

(edit-channel-permissions! conn
                           channel-id
                           overwrite-id
                           allow
                           deny
                           type
                           &
                           {:as opts :keys [user-agent audit-reason]})

Edits the channel's permissions of either a user or role. Returns a promise containing a boolean of if it succeeded.

Edits the channel's permissions of either a user or role. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

edit-followup-message!clj

(edit-followup-message!
  conn
  application-id
  interaction-token
  message-id
  &
  {:as opts :keys [content embeds allowed-mentions user-agent audit-reason]})

Edits a followup message to an interaction by its id.

Returns a promise containing the updated message object.

Edits a followup message to an interaction by its id.

Returns a promise containing the updated message object.
sourceraw docstring

edit-global-application-command!clj

(edit-global-application-command!
  conn
  application-id
  command-id
  &
  {:as opts
   :keys [ms.command/name ms.command/description ms.command/options
          ms.command/default_permission user-agent audit-reason]})

Updates an existing global slash command by its id.

Returns a promise containing the updated application command object.

Updates an existing global slash command by its id.

Returns a promise containing the updated application command object.
sourceraw docstring

edit-guild-application-command!clj

(edit-guild-application-command!
  conn
  application-id
  guild-id
  command-id
  &
  {:as opts
   :keys [ms.command/name ms.command/description ms.command/options
          ms.command/default_permission user-agent audit-reason]})

Updates an existing guild slash command by its id.

Returns a promise containing the updated application command object.

Updates an existing guild slash command by its id.

Returns a promise containing the updated application command object.
sourceraw docstring

edit-message!clj

(edit-message! conn
               channel-id
               message-id
               &
               {:as opts :keys [content embed user-agent audit-reason]})

Edits the given message with the new content or embed. Returns a promise containing the new message.

Edits the given message with the new content or embed. Returns a promise containing the new message.
sourceraw docstring

edit-original-interaction-response!clj

(edit-original-interaction-response!
  conn
  application-id
  interaction-token
  &
  {:as opts :keys [content embeds allowed-mentions user-agent audit-reason]})

Edits the inital response to the given interaction.

Returns a promise containing the updated message object

Edits the inital response to the given interaction.

Returns a promise containing the updated message object
sourceraw docstring

edit-webhook-message!clj

(edit-webhook-message!
  conn
  webhook-id
  webhook-token
  message-id
  &
  {:as opts :keys [content embeds allowed-mentions user-agent audit-reason]})

Edits a previously-sent webhook message from the same token.

Returns a promise containing the updated message object.

Edits a previously-sent webhook message from the same token.

Returns a promise containing the updated message object.
sourceraw docstring

execute-webhook!clj

(execute-webhook! conn
                  webhook-id
                  webhook-token
                  &
                  {:as opts
                   :keys [content file stream embeds wait username avatar-url
                          tts allowed-mentions user-agent audit-reason]})

Executes the given webhook. Returns a promise which contains either a boolean of if the message succeeded, or a map of the response body.

Executes the given webhook. Returns a promise which contains either a boolean of if the message succeeded, or a map of the response body.
sourceraw docstring

get-application-command-permissions!clj

(get-application-command-permissions! conn
                                      application-id
                                      guild-id
                                      command-id
                                      &
                                      {:as opts
                                       :keys [user-agent audit-reason]})

Returns a promose containing the permission settings for a specific application command accessible from the guild.

Returns a promose containing the permission settings for a specific application command accessible from the guild.
sourceraw docstring

get-channel!clj

(get-channel! conn channel-id & {:as opts :keys [user-agent audit-reason]})

Returns a promise containing a channel object.

Returns a promise containing a channel object.
sourceraw docstring

get-channel-invites!clj

(get-channel-invites! conn
                      channel-id
                      &
                      {:as opts :keys [user-agent audit-reason]})

Returns a promise containing a list of invite objects with invite metadata.

Returns a promise containing a list of invite objects with invite metadata.
sourceraw docstring

get-channel-message!clj

(get-channel-message! conn
                      channel-id
                      message-id
                      &
                      {:as opts :keys [user-agent audit-reason]})

Returns a promise containing the message object.

Returns a promise containing the message object.
sourceraw docstring

get-channel-messages!clj

(get-channel-messages!
  conn
  channel-id
  &
  {:as opts :keys [around before after limit user-agent audit-reason]})

Returns a promise containing a vector of message objects.

Returns a promise containing a vector of message objects.
sourceraw docstring

get-channel-webhooks!clj

(get-channel-webhooks! conn
                       channel-id
                       &
                       {:as opts :keys [user-agent audit-reason]})

Returns a promise containing a vector of webhook objects.

Returns a promise containing a vector of webhook objects.
sourceraw docstring

get-current-application-information!clj

(get-current-application-information! conn
                                      &
                                      {:as opts
                                       :keys [user-agent audit-reason]})

Returns a promise containing the bot's OAuth2 application info.

Returns  a promise containing the bot's OAuth2 application info.
sourceraw docstring

get-current-user!clj

(get-current-user! conn & {:as opts :keys [user-agent audit-reason]})

Returns a promise containing the user object for the current user.

Returns a promise containing the user object for the current user.
sourceraw docstring

get-current-user-guilds!clj

(get-current-user-guilds! conn
                          &
                          {:as opts
                           :keys [before after limit user-agent audit-reason]})

Returns a promise containing the current user's guilds. Pagination will be required if the bot is in over 100 guilds.

Returns a promise containing the current user's guilds. Pagination will be required if the bot is in over 100 guilds.
sourceraw docstring

get-global-application-commands!clj

(get-global-application-commands! conn
                                  application-id
                                  &
                                  {:as opts :keys [user-agent audit-reason]})

Returns a promise containing a vector of application command objects.

Returns a promise containing a vector of application command objects.
sourceraw docstring

get-guild!clj

(get-guild! conn
            guild-id
            &
            {:as opts :keys [with-counts user-agent audit-reason]})

Returns a promise containing the guild object.

Returns a promise containing the guild object.
sourceraw docstring

get-guild-application-commands!clj

(get-guild-application-commands! conn
                                 application-id
                                 guild-id
                                 &
                                 {:as opts :keys [user-agent audit-reason]})

Returns a promise containing a vector of application command objects.

Returns a promise containing a vector of application command objects.
sourceraw docstring

get-guild-audit-log!clj

(get-guild-audit-log! conn
                      guild-id
                      &
                      {:as opts :keys [user-agent audit-reason]})

Returns a promise containing an audit log object for the guild.

Returns a promise containing an audit log object for the guild.
sourceraw docstring

get-guild-ban!clj

(get-guild-ban! conn
                guild-id
                user-id
                &
                {:as opts :keys [user-agent audit-reason]})

Returns a promise containing a ban object for the given user.

Returns a promise containing a ban object for the given user.
sourceraw docstring

get-guild-bans!clj

(get-guild-bans! conn guild-id & {:as opts :keys [user-agent audit-reason]})

Returns a promise containing a vector of ban objects.

Returns a promise containing a vector of ban objects.
sourceraw docstring

get-guild-channels!clj

(get-guild-channels! conn guild-id & {:as opts :keys [user-agent audit-reason]})

Returns a promise containing a vector of channel objects.

Returns a promise containing a vector of channel objects.
sourceraw docstring

get-guild-embed!cljdeprecated

(get-guild-embed! conn guild-id & {:keys [user-agent audit-reason]})

Returns a promise containing the guild embed object.

DEPRECATED: Prefer using get-guild-widget-settings!

Returns a promise containing the guild embed object.

DEPRECATED: Prefer using [[get-guild-widget-settings!]]
sourceraw docstring

get-guild-emoji!clj

(get-guild-emoji! conn
                  guild-id
                  emoji
                  &
                  {:as opts :keys [user-agent audit-reason]})

Returns a promise containing the given guild emoji object.

Returns a promise containing the given guild emoji object.
sourceraw docstring

get-guild-guild-application-command-permissions!clj

(get-guild-guild-application-command-permissions!
  conn
  application-id
  guild-id
  &
  {:as opts :keys [user-agent audit-reason]})

Returns a promise containing the permission settings for all application commands accessible from the guild.

Returns a promise containing the permission settings for all application commands accessible from the guild.
sourceraw docstring

get-guild-integrations!clj

(get-guild-integrations! conn
                         guild-id
                         &
                         {:as opts :keys [user-agent audit-reason]})

Returns a promise containing a vector of guild integration objects.

Returns a promise containing a vector of guild integration objects.
sourceraw docstring

get-guild-invites!clj

(get-guild-invites! conn guild-id & {:as opts :keys [user-agent audit-reason]})

Returns a promise containing a vector of guild invite objects.

Returns a promise containing a vector of guild invite objects.
sourceraw docstring

get-guild-member!clj

(get-guild-member! conn
                   guild-id
                   user-id
                   &
                   {:as opts :keys [user-agent audit-reason]})

Returns a promise containing the guild member object.

Returns a promise containing the guild member object.
sourceraw docstring

get-guild-prune-count!clj

(get-guild-prune-count! conn
                        guild-id
                        &
                        {:as opts :keys [days user-agent audit-reason]})

Returns a promise containing the number of users to be pruned.

Returns a promise containing the number of users to be pruned.
sourceraw docstring

get-guild-roles!clj

(get-guild-roles! conn guild-id & {:as opts :keys [user-agent audit-reason]})

Returns a promise containing a vector of role objects.

Returns a promise containing a vector of role objects.
sourceraw docstring

get-guild-vanity-url!clj

(get-guild-vanity-url! conn
                       guild-id
                       &
                       {:as opts :keys [user-agent audit-reason]})

Returns a promise containing a partial invite object if the guild supports it, otherwise nil.

Returns a promise containing a partial invite object if the guild supports it, otherwise nil.
sourceraw docstring

get-guild-voice-regions!clj

(get-guild-voice-regions! conn
                          guild-id
                          &
                          {:as opts :keys [user-agent audit-reason]})

Returns a promise containing a vector of voice region objects.

Returns a promise containing a vector of voice region objects.
sourceraw docstring

get-guild-webhooks!clj

(get-guild-webhooks! conn guild-id & {:as opts :keys [user-agent audit-reason]})

Returns a promise containing a vector of webhook objects.

Returns a promise containing a vector of webhook objects.
sourceraw docstring

get-guild-widget!clj

(get-guild-widget! conn guild-id & {:as opts :keys [user-agent audit-reason]})

Returns a promise containing the guild widget object.

Returns a promise containing the guild widget object.
sourceraw docstring

get-guild-widget-image!clj

(get-guild-widget-image! conn
                         guild-id
                         &
                         {:as opts :keys [style user-agent audit-reason]})

Returns a promise containing the guild widget image.

Returns a promise containing the guild widget image.
sourceraw docstring

get-guild-widget-settings!clj

(get-guild-widget-settings! conn
                            guild-id
                            &
                            {:as opts :keys [user-agent audit-reason]})

Returns a promise containing the guild widget settings object.

Returns a promise containing the guild widget settings object.
sourceraw docstring

get-invite!clj

(get-invite! conn
             invite-code
             &
             {:as opts :keys [with-counts? user-agent audit-reason]})

Returns a promise containing the invite.

Returns a promise containing the invite.
sourceraw docstring

get-original-interaction-response!clj

(get-original-interaction-response! conn
                                    application-id
                                    interaction-token
                                    &
                                    {:as opts :keys [user-agent audit-reason]})

Returns a promise containing the response object sent for the given interaction.

Returns a promise containing the response object sent for the given interaction.
sourceraw docstring

get-pinned-messages!clj

(get-pinned-messages! conn
                      channel-id
                      &
                      {:as opts :keys [user-agent audit-reason]})

Returns a promise containing a list of message objects.

Returns a promise containing a list of message objects.
sourceraw docstring

get-reactions!clj

(get-reactions! conn
                channel-id
                message-id
                emoji
                &
                {:as opts :keys [before after limit user-agent audit-reason]})

Returns a promise containing a list of all users who reacted to the message with the emoji (either unicode or "name:id" for a custom emoji), based on the provided limits.

Returns a promise containing a list of all users who reacted to the message with the emoji (either unicode or "name:id" for a custom emoji), based on the provided limits.
sourceraw docstring

get-user!clj

(get-user! conn user-id & {:as opts :keys [user-agent audit-reason]})

Returns a promise containing the user object for the given user.

Returns a promise containing the user object for the given user.
sourceraw docstring

get-user-connections!clj

(get-user-connections! conn & {:as opts :keys [user-agent audit-reason]})

NOT INTENDED FOR BOT USE. Returns a promise containing a vector of connection objects.

NOT INTENDED FOR BOT USE. Returns a promise containing a vector of connection objects.
sourceraw docstring

get-user-dms!clj

(get-user-dms! conn & {:as opts :keys [user-agent audit-reason]})

Returns a promise containing a vector of DM channel objects.

Returns a promise containing a vector of DM channel objects.
sourceraw docstring

get-webhook!clj

(get-webhook! conn webhook-id & {:as opts :keys [user-agent audit-reason]})

Returns a promise containing a webhook object.

Returns a promise containing a webhook object.
sourceraw docstring

get-webhook-message!clj

(get-webhook-message! conn
                      webhook-id
                      webhook-token
                      message-id
                      &
                      {:as opts :keys [user-agent audit-reason]})

Returns the webhook message sent by the given webhook with the given id.

Returns the webhook message sent by the given webhook with the given id.
sourceraw docstring

get-webhook-with-token!clj

(get-webhook-with-token! conn
                         webhook-id
                         webhook-token
                         &
                         {:as opts :keys [user-agent audit-reason]})

Returns a promise containing a webhook object, but does not require authentication.

Returns a promise containing a webhook object, but does not require authentication.
sourceraw docstring

group-dm-add-recipient!clj

(group-dm-add-recipient! conn
                         channel-id
                         user-id
                         &
                         {:as opts
                          :keys [access-token nick user-agent audit-reason]})

NOT INTENDED FOR BOT USE. Adds a new recipient to a group DM channel. Requires an access token.

NOT INTENDED FOR BOT USE. Adds a new recipient to a group DM channel. Requires an access token.
sourceraw docstring

group-dm-remove-recipient!clj

(group-dm-remove-recipient! conn
                            channel-id
                            user-id
                            &
                            {:as opts :keys [user-agent audit-reason]})

NOT INTENDED FOR BOT USE. Removes a recipient from a group DM channel. Requires an access token.

NOT INTENDED FOR BOT USE. Removes a recipient from a group DM channel. Requires an access token.
sourceraw docstring

leave-guild!clj

(leave-guild! conn guild-id & {:as opts :keys [user-agent audit-reason]})

Current user leaves the given guild. Returns a promise containing a boolean of if it succeeded.

Current user leaves the given guild. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

list-guild-emojis!clj

(list-guild-emojis! conn guild-id & {:as opts :keys [user-agent audit-reason]})

Returns a promise containing a vector of guild emoji objects.

Returns a promise containing a vector of guild emoji objects.
sourceraw docstring

list-guild-members!clj

(list-guild-members! conn
                     guild-id
                     &
                     {:as opts :keys [limit after user-agent audit-reason]})

Returns a promise containing a vector of the guild member objects.

Returns a promise containing a vector of the guild member objects.
sourceraw docstring

list-voice-regions!clj

(list-voice-regions! conn & {:as opts :keys [user-agent audit-reason]})

Returns a promise containing a vector of voice regions.

Returns a promise containing a vector of voice regions.
sourceraw docstring

modifiy-guild-role!clj

(modifiy-guild-role! conn
                     guild-id
                     role-id
                     &
                     {:as opts
                      :keys [name permissions color hoist mentionable user-agent
                             audit-reason]})

Modifies the given role. Returns a promise containing the modified role object.

Modifies the given role. Returns a promise containing the modified role object.
sourceraw docstring

modify-channel!clj

(modify-channel! conn
                 channel-id
                 &
                 {:as opts
                  :keys [name position topic nsfw rate-limit-per-user bitrate
                         user-limit permission-overwrites parent-id user-agent
                         audit-reason]})

Updates a channel's settings. Returns a promise containing the channel object.

Updates a channel's settings. Returns a promise containing the channel object.
sourceraw docstring

modify-current-user!clj

(modify-current-user! conn
                      &
                      {:as opts
                       :keys [username avatar user-agent audit-reason]})

Modifies the current user object. Returns a promise containing the modified user object.

Modifies the current user object. Returns a promise containing the modified user object.
sourceraw docstring

modify-current-user-nick!clj

(modify-current-user-nick! conn
                           guild-id
                           nick
                           &
                           {:as opts :keys [user-agent audit-reason]})

Modifies the username of the current user. Returns a promise containing either nil on failure or the new nickname on success.

Modifies the username of the current user. Returns a promise containing either nil on failure or the new nickname on success.
sourceraw docstring

modify-guild!clj

(modify-guild! conn
               guild-id
               &
               {:as opts
                :keys [reason name region verification-level
                       default-message-notifications explicit-content-filter
                       afk-channel-id afk-timeout icon owner-id splash
                       system-channel-id user-agent audit-reason]})

Modifies an existing guild. Returns a promise containing the modified guild object.

Modifies an existing guild. Returns a promise containing the modified guild object.
sourceraw docstring

modify-guild-channel-positions!clj

(modify-guild-channel-positions! conn
                                 guild-id
                                 channels
                                 &
                                 {:as opts :keys [user-agent audit-reason]})

Modifies an existing channel. Returns a promise containing the modified channel object.

Modifies an existing channel. Returns a promise containing the modified channel object.
sourceraw docstring

modify-guild-embed!cljdeprecated

(modify-guild-embed! conn guild-id embed & {:keys [user-agent audit-reason]})

Modifies the guild embed object. Returns a promise containing the modified guild embed object.

DEPRECATED: Prefer using get-guild-widget-settings!

Modifies the guild embed object. Returns a promise containing the modified guild embed object.

DEPRECATED: Prefer using [[get-guild-widget-settings!]]
sourceraw docstring

modify-guild-emoji!clj

(modify-guild-emoji! conn
                     guild-id
                     emoji
                     name
                     roles
                     &
                     {:as opts :keys [user-agent audit-reason]})

Modifies an existing guild emoji. Returns a promise containing the modified emoji object.

Modifies an existing guild emoji. Returns a promise containing the modified emoji object.
sourceraw docstring

modify-guild-integration!clj

(modify-guild-integration! conn
                           guild-id
                           integration-id
                           expire-behavior
                           expire-grace-period
                           enable-emoticons
                           &
                           {:as opts :keys [user-agent audit-reason]})

Modifies an existing guild integration. Returns a promise containing a boolean of if it succeeded.

Modifies an existing guild integration. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

modify-guild-member!clj

(modify-guild-member!
  conn
  guild-id
  user-id
  &
  {:as opts :keys [nick roles mute deaf channel-id user-agent audit-reason]})

Modifies a guild member. Returns a promise containing the modified guild member object.

Modifies a guild member. Returns a promise containing the modified guild member object.
sourceraw docstring

modify-guild-role-positions!clj

(modify-guild-role-positions! conn
                              guild-id
                              roles
                              &
                              {:as opts :keys [user-agent audit-reason]})

Modifies the position of the roles in the vector. Vector must contain at least two roles, each a map with :id and :position. Returns a promise containing a vector of the guild roles.

Modifies the position of the roles in the vector. Vector must contain at least two roles, each a map with :id and :position. Returns a promise containing a vector of the guild roles.
sourceraw docstring

modify-guild-widget!clj

(modify-guild-widget! conn
                      guild-id
                      embed
                      &
                      {:as opts :keys [user-agent audit-reason]})

Modifies a guild widget object. Returns a promise containing the modified guild widget.

Modifies a guild widget object. Returns a promise containing the modified guild widget.
sourceraw docstring

modify-webhook!clj

(modify-webhook! conn
                 webhook-id
                 &
                 {:as opts
                  :keys [name avatar channel-id user-agent audit-reason]})

Returns a promise containing the modified webhook object.

Returns a promise containing the modified webhook object.
sourceraw docstring

modify-webhook-with-token!clj

(modify-webhook-with-token!
  conn
  webhook-id
  webhook-token
  &
  {:as opts :keys [name avatar channel-id user-agent audit-reason]})

Returns a promise containing the modified webhook object, but does not require authentication.

Returns a promise containing the modified webhook object, but does not require authentication.
sourceraw docstring

remove-guild-ban!clj

(remove-guild-ban! conn
                   guild-id
                   user-id
                   &
                   {:as opts :keys [user-agent audit-reason]})

Unbans a user. Returns a promise containing a boolean of if it succeeded.

Unbans a user. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

remove-guild-member!clj

(remove-guild-member! conn
                      guild-id
                      user-id
                      &
                      {:as opts :keys [user-agent audit-reason]})

Kicks the member from the guild. Returns a promise containing a boolean of if it succeeded.

Kicks the member from the guild. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

remove-guild-member-role!clj

(remove-guild-member-role! conn
                           guild-id
                           user-id
                           role-id
                           &
                           {:as opts :keys [user-agent audit-reason]})

Removes the role from the user. Returns a promise containing a boolean of if it succeeded.

Removes the role from the user. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

send-message!cljdeprecated

(send-message! conn channel-id msg & {:keys [tts none embed file] :as opts})
source

spec-nsclj

source

start-connection!clj

(start-connection! token)

Takes a token for a bot, and returns a channel which is passed to the various messaging functions.

Takes a token for a bot, and returns a channel which is passed
to the various messaging functions.
sourceraw docstring

stop-connection!clj

(stop-connection! conn)

Takes a channel returned by start-connection! and stops the associated connection.

Takes a channel returned by start-connection! and stops the associated
connection.
sourceraw docstring

sync-guild-integration!clj

(sync-guild-integration! conn
                         guild-id
                         integration-id
                         &
                         {:as opts :keys [user-agent audit-reason]})

Syncs the guild integration. Returns a promise containing a boolean of if it succeeded.

Syncs the guild integration. Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

trigger-typing-indicator!clj

(trigger-typing-indicator! conn
                           channel-id
                           &
                           {:as opts :keys [user-agent audit-reason]})

Triggers the typing indicator in the given channel (not recommended for bots unless about to send a message which takes a while to compute). Returns a promise containing a boolean of if it succeeded.

Triggers the typing indicator in the given channel (not recommended for bots unless about to send a message which takes a while to compute). Returns a promise containing a boolean of if it succeeded.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close