Packages

t

net.katsstuff.ackcord.http.rest

BaseRESTRequest

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

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.

Linear Supertypes
Request[RawResponse, Ctx], MaybeRequest[RawResponse, Ctx], AnyRef, Any
Known Subclasses
AddGuildMember, AddGuildMemberRole, AddPinnedChannelMessages, BeginGuildPrune, BulkDeleteMessages, CreateChannelInvite, CreateDm, CreateGroupDm, CreateGuild, CreateGuildBan, CreateGuildChannel, CreateGuildEmoji, CreateGuildIntegration, CreateGuildRole, CreateMessage, CreateReaction, CreateWebhook, DeleteAllReactions, DeleteChannelPermission, DeleteCloseChannel, DeleteGuild, DeleteGuildEmoji, DeleteGuildIntegration, DeleteGuildRole, DeleteInvite, DeleteMessage, DeleteOwnReaction, DeletePinnedChannelMessages, DeleteUserReaction, DeleteWebhook, DeleteWebhookWithToken, EditChannelPermissions, EditMessage, GetChannel, GetChannelInvites, GetChannelMessage, GetChannelMessages, GetChannelWebhooks, GetCurrentUser, GetCurrentUserGuilds, GetGuild, GetGuildAuditLog, GetGuildBan, GetGuildBans, GetGuildChannels, GetGuildEmbed, GetGuildEmoji, GetGuildIntegrations, GetGuildInvites, GetGuildMember, GetGuildPruneCount, GetGuildRoles, GetGuildVanityUrl, GetGuildVoiceRegions, GetGuildWebhooks, GetInvite, GetPinnedMessages, GetReactions, GetUser, GetUserConnections, GetWebhook, GetWebhookWithToken, GuildMemberRequest, GuildPrune, LeaveGuild, ListGuildEmojis, ListGuildMembers, ListVoiceRegions, ModifyBotUsersNick, ModifyChannel, ModifyGuild, ModifyGuildChannelPositions, ModifyGuildEmbed, ModifyGuildEmoji, ModifyGuildIntegration, ModifyGuildMember, ModifyGuildRole, ModifyGuildRolePositions, ModifyWebhook, ModifyWebhookWithToken, NoNiceResponseReasonRequest, NoNiceResponseRequest, NoParamsNiceResponseReasonRequest, NoParamsNiceResponseRequest, NoParamsReasonRequest, NoParamsRequest, NoParamsResponseReasonRequest, NoParamsResponseRequest, NoResponseReasonRequest, NoResponseRequest, RESTRequest, ReasonRequest, RemoveGuildBan, RemoveGuildMember, RemoveGuildMemberRole, SyncGuildIntegration, TriggerTypingIndicator
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. All

Abstract Value Members

  1. abstract def bodyForLogging: Option[String]
    Definition Classes
    Request
  2. abstract def context: Ctx
    Definition Classes
    MaybeRequest
  3. abstract def requestBody: RequestEntity
    Definition Classes
    Request
  4. abstract def responseDecoder: Decoder[RawResponse]

    A decoder to decode the response.

  5. abstract def route: RequestRoute
    Definition Classes
    Request
  6. 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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. def collect[B](f: PartialFunction[RawResponse, B]): Request[B, Ctx]
    Definition Classes
    Request
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def extraHeaders: Seq[HttpHeader]
    Definition Classes
    Request
  10. def filter(f: (RawResponse) ⇒ Boolean): Request[RawResponse, Ctx]
    Definition Classes
    Request
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hasPermissions[F[_]](implicit c: CacheSnapshot[F], F: Monad[F]): F[Boolean]
    Definition Classes
    BaseRESTRequest → Request
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def map[B](f: (RawResponse) ⇒ B): Request[B, Ctx]
    Definition Classes
    Request
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. def parseResponse(parallelism: Int)(implicit system: ActorSystem): Flow[ResponseEntity, RawResponse, NotUsed]
    Definition Classes
    BaseRESTRequest → Request
  21. def requiredPermissions: Permission

    The permissions needed to use this request.

  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. def transformResponse[B](f: (Flow[ResponseEntity, RawResponse, NotUsed]) ⇒ Flow[ResponseEntity, B, NotUsed]): Request[B, Ctx]
    Definition Classes
    Request
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  28. def withContext[NewCtx](newContext: NewCtx): Request[RawResponse, NewCtx]
    Definition Classes
    Request

Inherited from Request[RawResponse, Ctx]

Inherited from MaybeRequest[RawResponse, Ctx]

Inherited from AnyRef

Inherited from Any

Ungrouped