Packages

t

ackcord.requests

RESTRequest

trait RESTRequest[Params, RawResponse, NiceResponse] extends BaseRESTRequest[RawResponse, NiceResponse]

A simpler, request trait where the params are defined explicitly and converted to json.

Params

The json parameters of the request.

Source
baseRequestObjs.scala
Linear Supertypes
BaseRESTRequest[RawResponse, NiceResponse], Request[RawResponse], AnyRef, Any
Known Subclasses
BatchEditApplicationCommandPermissions, BulkOverwriteGlobalApplicationCommands, BulkOverwriteGuildApplicationCommands, CreateGlobalApplicationCommand, CreateGuildApplicationCommand, CreateInteractionResponse, DeleteGlobalApplicationCommand, DeleteGuildApplicationCommand, EditApplicationCommandPermissions, EditGlobalApplicationCommand, EditGuildApplicationCommand, GetApplicationCommandPermissions, GetGlobalApplicationCommand, GetGlobalApplicationCommands, GetGuildApplicationCommand, GetGuildApplicationCommandPermissions, GetGuildApplicationCommands, AddGuildMember, AddGuildMemberRole, AddThreadMember, BeginGuildPrune, BulkDeleteMessages, CreateChannelInvite, CreateDm, CreateFollowupMessage, CreateGuild, CreateGuildBan, CreateGuildChannel, CreateGuildEmoji, CreateGuildFromTemplate, CreateGuildRole, CreateGuildScheduledEvent, CreateGuildSticker, CreateGuildTemplate, CreateMessage, CreateReaction, CreateStageInstance, CreateWebhook, CrosspostMessage, DeleteAllReactions, DeleteAllReactionsForEmoji, DeleteChannelPermission, DeleteCloseChannel, DeleteGuild, DeleteGuildEmoji, DeleteGuildIntegration, DeleteGuildRole, DeleteGuildScheduledEvent, DeleteGuildSticker, DeleteGuildTemplate, DeleteInvite, DeleteMessage, DeleteOriginalWebhookMessage, DeleteOwnReaction, DeleteStageInstance, DeleteUserReaction, DeleteWebhook, DeleteWebhookMessage, DeleteWebhookWithToken, EditChannelPermissions, EditMessage, EditOriginalWebhookMessage, EditWebhookMessage, ExecuteWebhook, FollowNewsChannel, GetChannel, GetChannelInvites, GetChannelMessage, GetChannelMessages, GetChannelWebhooks, GetCurrentUser, GetCurrentUserGuilds, GetGuild, GetGuildAuditLog, GetGuildBan, GetGuildBans, GetGuildChannels, GetGuildEmoji, GetGuildIntegrations, GetGuildInvites, GetGuildMember, GetGuildPreview, GetGuildPruneCount, GetGuildRoles, GetGuildScheduledEvent, GetGuildScheduledEventUsers, GetGuildSticker, GetGuildTemplate, GetGuildTemplates, GetGuildVanityUrl, GetGuildVoiceRegions, GetGuildWebhooks, GetGuildWelcomeScreen, GetGuildWidget, GetGuildWidgetSettings, GetInvite, GetOriginalWebhookMessage, GetPinnedMessages, GetReactions, GetStageInstance, GetSticker, GetThreadMember, GetUser, GetUserConnections, GetWebhook, GetWebhookMessage, GetWebhookWithToken, GuildMemberRequest, JoinThread, LeaveGuild, LeaveThread, ListActiveGuildThreads, ListGuildEmojis, ListGuildMembers, ListGuildStickers, ListJoinedPrivateArchivedThreads, ListNitroStickerPacks, ListPrivateArchivedThreads, ListPublicArchivedThreads, ListScheduledEventsForGuild, ListThreadMembers, ListVoiceRegions, ModifyChannel, ModifyCurrentMember, ModifyCurrentUser, ModifyGuild, ModifyGuildChannelPositions, ModifyGuildEmoji, ModifyGuildMember, ModifyGuildRole, ModifyGuildRolePositions, ModifyGuildScheduledEvent, ModifyGuildSticker, ModifyGuildTemplate, ModifyGuildWelcomeScreen, ModifyGuildWidget, ModifyWebhook, ModifyWebhookWithToken, NoNiceResponseReasonRequest, NoNiceResponseRequest, NoParamsNiceResponseReasonRequest, NoParamsNiceResponseRequest, NoParamsReasonRequest, NoParamsRequest, NoParamsResponseReasonRequest, NoParamsResponseRequest, NoResponseReasonRequest, NoResponseRequest, GetCurrentAuthorizationInformation, GetCurrentBotApplicationInformation, PinMessage, ReasonRequest, RemoveGuildBan, RemoveGuildMember, RemoveGuildMemberRole, RemoveThreadMember, SearchGuildMembers, StartThreadWithMessage, StartThreadWithoutMessage, SyncGuildTemplate, TriggerTypingIndicator, UnpinMessage, UpdateCurrentUserVoiceState, UpdateStageInstance, UpdateUserVoiceState, CreateGroupDm, ListActiveChannelThreads, ModifyBotUsersNick
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RESTRequest
  2. BaseRESTRequest
  3. Request
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def params: Params

    The params of this request

  2. abstract def paramsEncoder: Encoder[Params]

    An encoder for the params of this request

  3. abstract def responseDecoder: Decoder[RawResponse]

    A decoder to decode the response.

    A decoder to decode the response.

    Definition Classes
    BaseRESTRequest
  4. abstract def route: RequestRoute

    The router for this request.

    The router for this request.

    Definition Classes
    Request
  5. abstract def toNiceResponse(response: RawResponse): NiceResponse

    Convert the response to a format the cache handler can understand.

    Convert the response to a format the cache handler can understand.

    Definition Classes
    BaseRESTRequest

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def bodyForLogging: Option[String]

    Returns the body of this Request for use in logging.

    Returns the body of this Request for use in logging.

    Definition Classes
    RESTRequestRequest
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. def collect[B](f: PartialFunction[RawResponse, B]): Request[B]

    Map the result if the function is defined for the response data.

    Map the result if the function is defined for the response data.

    Definition Classes
    Request
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def extraHeaders: Seq[HttpHeader]

    All the extra headers to send with this request.

    All the extra headers to send with this request.

    Definition Classes
    Request
  11. def filter(f: (RawResponse) => Boolean): Request[RawResponse]

    Filter the response of sending this request.

    Filter the response of sending this request.

    Definition Classes
    Request
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. def hasPermissions(implicit c: CacheSnapshot): Boolean

    Check if a client has the needed permissions to execute this request.

    Check if a client has the needed permissions to execute this request.

    Definition Classes
    BaseRESTRequestRequest
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  15. val identifier: UUID

    An unique identifier to track this request from creation to answer.

    An unique identifier to track this request from creation to answer.

    Definition Classes
    Request
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. def jsonParams: Json

    The params of this request converted to json.

  18. def jsonPrinter: Printer
  19. def map[B](f: (RawResponse) => B): Request[B]

    Map the result of sending this request.

    Map the result of sending this request.

    Definition Classes
    Request
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  23. def parseResponse(entity: ResponseEntity)(implicit system: ActorSystem[Nothing]): Future[RawResponse]

    A flow that can be used to parse the responses from this request.

    A flow that can be used to parse the responses from this request.

    Definition Classes
    BaseRESTRequestRequest
  24. def requestBody: RequestEntity

    The body of the request to send.

    The body of the request to send.

    Definition Classes
    RESTRequestRequest
  25. def requiredPermissions: Permission

    The permissions needed to use this request.

    The permissions needed to use this request.

    Definition Classes
    BaseRESTRequest
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. def transformResponse[B](f: (ExecutionContext) => (Future[RawResponse]) => Future[B]): Request[B]

    Transform the response of this request as a flow.

    Transform the response of this request as a flow.

    Definition Classes
    Request
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from BaseRESTRequest[RawResponse, NiceResponse]

Inherited from Request[RawResponse]

Inherited from AnyRef

Inherited from Any

Ungrouped