o

ackcord.util

BulkRequestMembers

object BulkRequestMembers

Source
BulkRequestMembers.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BulkRequestMembers
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. def seqUserIds(guild: GuildId, userIds: Seq[UserId], events: Events, timeout: FiniteDuration = 30.seconds)(implicit system: ActorSystem[Nothing]): Future[Ior[Seq[(GuildId, UserId)], Seq[RawGuildMemberWithGuild]]]

    Request members for all the users passed in.

    Request members for all the users passed in.

    Beware that this method uses more memory than consuming the elements as they are gotten using sourceUserIds.

    guild

    The guild to get the members for the users in.

    userIds

    The users to get the members for.

    events

    An events instance to send the requests with.

    returns

    A future Ior containing on the left members not found, and on the right members found. The returned members are represented with RawGuildMemberWithGuild which is like a ackcord.data.GuildMember together with a ackcord.data.User.

  2. def seqUsernameQuery(guild: GuildId, query: String, events: Events, limit: Int = 100, timeout: FiniteDuration = 30.seconds)(implicit system: ActorSystem[Nothing]): Future[Seq[RawGuildMemberWithGuild]]

    Request members for a given username query.

    Request members for a given username query.

    guild

    The guild to get the members in.

    query

    The username query to search for. Must not be empty.

    events

    An events instance to send the requests with.

    limit

    Max amount of members to get.

    returns

    A future seq containing members who's username starts with the query. The returned members are represented with RawGuildMemberWithGuild which is like a ackcord.data.GuildMember together with a ackcord.data.User.

  3. def sourceUserIds(guild: GuildId, userIds: Seq[UserId], events: Events, timeout: FiniteDuration = 30.seconds)(implicit system: ActorSystem[Nothing]): Source[RawGuildMemberWithGuild, Future[Seq[(GuildId, UserId)]]]

    Request members for all the users passed in.

    Request members for all the users passed in.

    guild

    The guild to get the members for the users in.

    userIds

    The users to get the members for.

    events

    An events instance to send the requests with.

    returns

    A source containing the members for the user ids passed in. The materialized value of the source is all the members not found. The returned members are represented with RawGuildMemberWithGuild which is like a ackcord.data.GuildMember together with a ackcord.data.User.

  4. def sourceUsernameQuery(guild: GuildId, query: String, events: Events, limit: Int = 100, timeout: FiniteDuration = 30.seconds)(implicit system: ActorSystem[Nothing]): Source[RawGuildMemberWithGuild, NotUsed]

    Request members for a given username query.

    Request members for a given username query.

    guild

    The guild to get the members in.

    query

    The username query to search for. Must not be empty.

    events

    An events instance to send the requests with.

    limit

    Max amount of members to get.

    returns

    A source containing members who's username starts with the query. The returned members are represented with RawGuildMemberWithGuild which is like a ackcord.data.GuildMember together with a ackcord.data.User.