Packages

t

ackcord.requests

BaseRESTRequest

trait BaseRESTRequest[RawResponse, NiceResponse] extends Request[RawResponse]

Base trait for all REST requests in AckCord. If you feel an endpoint is missing, and AckCord hasn't added it yet, you can extend this and create your own request. I'd recommend you to extend RESTRequest tough for simplicity.

RawResponse

The response type of the request

NiceResponse

A nicer and less raw type of response created from the response.

Self Type
BaseRESTRequest[RawResponse, NiceResponse]
Source
baseRequestObjs.scala
Linear Supertypes
Request[RawResponse], MaybeRequest[RawResponse], AnyRef, Any
Known Subclasses
AddGuildMember, AddGuildMemberRole, AddPinnedChannelMessages, BeginGuildPrune, BulkDeleteMessages, CreateChannelInvite, CreateDm, CreateGuild, CreateGuildBan, CreateGuildChannel, CreateGuildEmoji, CreateGuildFromTemplate, CreateGuildIntegration, CreateGuildRole, CreateMessage, CreateReaction, CreateWebhook, CrosspostMessage, DeleteAllReactions, DeleteAllReactionsForEmoji, DeleteChannelPermission, DeleteCloseChannel, DeleteGuild, DeleteGuildEmoji, DeleteGuildIntegration, DeleteGuildRole, DeleteInvite, DeleteMessage, DeleteOwnReaction, DeletePinnedChannelMessages, DeleteUserReaction, DeleteWebhook, DeleteWebhookWithToken, EditChannelPermissions, EditMessage, FollowNewsChannel, GetChannel, GetChannelInvites, GetChannelMessage, GetChannelMessages, GetChannelWebhooks, GetCurrentUser, GetCurrentUserGuilds, GetGuild, GetGuildAuditLog, GetGuildBan, GetGuildBans, GetGuildChannels, GetGuildEmoji, GetGuildIntegrations, GetGuildInvites, GetGuildMember, GetGuildPreview, GetGuildPruneCount, GetGuildRoles, GetGuildVanityUrl, GetGuildVoiceRegions, GetGuildWebhooks, GetGuildWidget, GetGuildWidgetSettings, GetInvite, GetPinnedMessages, GetReactions, GetTemplate, GetUser, GetUserConnections, GetWebhook, GetWebhookWithToken, GuildMemberRequest, LeaveGuild, ListGuildEmojis, ListGuildMembers, ListVoiceRegions, ModifyBotUsersNick, ModifyChannel, ModifyCurrentUser, ModifyGuild, ModifyGuildChannelPositions, ModifyGuildEmoji, ModifyGuildIntegration, ModifyGuildMember, ModifyGuildRole, ModifyGuildRolePositions, ModifyGuildWidget, ModifyWebhook, ModifyWebhookWithToken, NoNiceResponseReasonRequest, NoNiceResponseRequest, NoParamsNiceResponseReasonRequest, NoParamsNiceResponseRequest, NoParamsReasonRequest, NoParamsRequest, NoParamsResponseReasonRequest, NoParamsResponseRequest, NoResponseReasonRequest, NoResponseRequest, GetCurrentApplicationInformation, RESTRequest, ReasonRequest, RemoveGuildBan, RemoveGuildMember, RemoveGuildMemberRole, SyncGuildIntegration, TriggerTypingIndicator, CreateGroupDm
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BaseRESTRequest
  2. Request
  3. MaybeRequest
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract 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
    Request
  2. abstract def requestBody: RequestEntity

    The body of the request to send.

    The body of the request to send.

    Definition Classes
    Request
  3. abstract def responseDecoder: Decoder[RawResponse]

    A decoder to decode the response.

  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.

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. 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
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. 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
  10. def filter(f: (RawResponse) => Boolean): Request[RawResponse]

    Filter the response of sending this request.

    Filter the response of sending this request.

    Definition Classes
    Request
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  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()
  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 map[B](f: (RawResponse) => B): Request[B]

    Map the result of sending this request.

    Map the result of sending this request.

    Definition Classes
    Request
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. 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
  22. def requiredPermissions: Permission

    The permissions needed to use this request.

  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. 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
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Request[RawResponse]

Inherited from MaybeRequest[RawResponse]

Inherited from AnyRef

Inherited from Any

Ungrouped