Packages

c

ackcord.requests

GetUserAvatarImage

case class GetUserAvatarImage(desiredSize: Int, format: ImageFormat, userId: UserId, avatarHash: String) extends ImageRequest with Product with Serializable

Get the image of a user avatar. Allowed formats are PNG, JPEG, WebP and GIF.

Source
imageRequests.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GetUserAvatarImage
  2. Serializable
  3. Product
  4. Equals
  5. ImageRequest
  6. Request
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new GetUserAvatarImage(desiredSize: Int, format: ImageFormat, userId: UserId, avatarHash: String)

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. def allowedFormats: Seq[ImageFormat]

    The allowed formats for this image.

    The allowed formats for this image.

    Definition Classes
    GetUserAvatarImageImageRequest
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val avatarHash: String
  7. 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
    ImageRequestRequest
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  9. def collect[B](f: PartialFunction[ByteString, 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
  10. val desiredSize: Int

    The desired size of the image.

    The desired size of the image. Must be between 16 and 2048, and must be a power of 2.

    Definition Classes
    GetUserAvatarImageImageRequest
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. 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
  13. def filter(f: (ByteString) => Boolean): Request[ByteString]

    Filter the response of sending this request.

    Filter the response of sending this request.

    Definition Classes
    Request
  14. val format: ImageFormat

    The format to get the image in.

    The format to get the image in.

    Definition Classes
    GetUserAvatarImageImageRequest
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  16. 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
    ImageRequestRequest
  17. 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
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def map[B](f: (ByteString) => 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[ByteString]

    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
    ImageRequestRequest
  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. def requestBody: RequestEntity

    The body of the request to send.

    The body of the request to send.

    Definition Classes
    ImageRequestRequest
  26. def route: RequestRoute

    The router for this request.

    The router for this request.

    Definition Classes
    GetUserAvatarImageRequest
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def transformResponse[B](f: (ExecutionContext) => (Future[ByteString]) => 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. val userId: UserId
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. 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 Serializable

Inherited from Product

Inherited from Equals

Inherited from ImageRequest

Inherited from Request[ByteString]

Inherited from AnyRef

Inherited from Any

Ungrouped