Packages

c

ackcord.requests

GetGuildScheduledEventUsers

case class GetGuildScheduledEventUsers(guildId: GuildId, guildScheduledEventId: SnowflakeType[GuildScheduledEvent], limit: Option[Int] = None, withMember: Option[Boolean] = None, before: Option[UserId] = None, after: Option[UserId] = None) extends NoParamsNiceResponseRequest[Seq[GuildScheduledEventUser]] with Product with Serializable

Get the users that have subscribed to a guild scheduled event.

limit

How many users to receive.

withMember

If the members should be included if they exist.

before

Only return users before the given user id.

after

Only return users after the given user id.

Source
guildScheduledEventsRequests.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GetGuildScheduledEventUsers
  2. Serializable
  3. Product
  4. Equals
  5. NoParamsNiceResponseRequest
  6. NoNiceResponseRequest
  7. NoParamsRequest
  8. RESTRequest
  9. BaseRESTRequest
  10. Request
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new GetGuildScheduledEventUsers(guildId: GuildId, guildScheduledEventId: SnowflakeType[GuildScheduledEvent], limit: Option[Int] = None, withMember: Option[Boolean] = None, before: Option[UserId] = None, after: Option[UserId] = None)

    limit

    How many users to receive.

    withMember

    If the members should be included if they exist.

    before

    Only return users before the given user id.

    after

    Only return users after the given user id.

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. val after: Option[UserId]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val before: Option[UserId]
  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
    RESTRequestRequest
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  9. def collect[B](f: PartialFunction[Seq[GuildScheduledEventUser], 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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. 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
  12. def filter(f: (Seq[GuildScheduledEventUser]) => Boolean): Request[Seq[GuildScheduledEventUser]]

    Filter the response of sending this request.

    Filter the response of sending this request.

    Definition Classes
    Request
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. val guildId: GuildId
  15. val guildScheduledEventId: SnowflakeType[GuildScheduledEvent]
  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
    BaseRESTRequestRequest
  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 jsonParams: Json

    The params of this request converted to json.

    The params of this request converted to json.

    Definition Classes
    RESTRequest
  20. def jsonPrinter: Printer
    Definition Classes
    RESTRequest
  21. val limit: Option[Int]
  22. def map[B](f: (Seq[GuildScheduledEventUser]) => B): Request[B]

    Map the result of sending this request.

    Map the result of sending this request.

    Definition Classes
    Request
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  26. def params: NotUsed

    The params of this request

    The params of this request

    Definition Classes
    NoParamsRequestRESTRequest
  27. def paramsEncoder: Encoder[NotUsed]

    An encoder for the params of this request

    An encoder for the params of this request

    Definition Classes
    NoParamsRequestRESTRequest
  28. def parseResponse(entity: ResponseEntity)(implicit system: ActorSystem[Nothing]): Future[Seq[GuildScheduledEventUser]]

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

    The body of the request to send.

    The body of the request to send.

    Definition Classes
    RESTRequestRequest
  31. def requiredPermissions: Permission

    The permissions needed to use this request.

    The permissions needed to use this request.

    Definition Classes
    BaseRESTRequest
  32. def responseDecoder: Decoder[Seq[GuildScheduledEventUser]]

    A decoder to decode the response.

    A decoder to decode the response.

    Definition Classes
    GetGuildScheduledEventUsersBaseRESTRequest
  33. def route: RequestRoute

    The router for this request.

    The router for this request.

    Definition Classes
    GetGuildScheduledEventUsersRequest
  34. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  35. def toNiceResponse(response: Seq[GuildScheduledEventUser]): Seq[GuildScheduledEventUser]

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

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

    Definition Classes
    NoNiceResponseRequestBaseRESTRequest
  36. def transformResponse[B](f: (ExecutionContext) => (Future[Seq[GuildScheduledEventUser]]) => 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
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. val withMember: Option[Boolean]

Deprecated Value Members

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

Ungrouped