Function getMultiple

  • getMultiple(this, from?, filter?, config?): Promise<{
        beatmaps: Beatmap.Extended[];
        beatmapsets: Beatmapset.Extended[];
        cursor_string: string | null;
        discussions: WithStartingpost[];
        included_discussions: WithStartingpost[];
        reviews_config: {
            max_blocks: number;
        };
        users: WithGroups[];
    }>

  • Get complex data about the discussion page of any beatmapet that you want!

    Parameters

    • this: API
    • Optionalfrom: {
          beatmapset?: number | Beatmapset;
          status?:
              | "ranked"
              | "all"
              | "qualified"
              | "disqualified"
              | "never_qualified";
          user?: number | User;
      }

      From where/who are the discussions coming from? Maybe only qualified sets?

      • Optionalbeatmapset?: number | Beatmapset
      • Optionalstatus?:
            | "ranked"
            | "all"
            | "qualified"
            | "disqualified"
            | "never_qualified"
      • Optionaluser?: number | User
    • Optionalfilter: {
          only_unresolved?: boolean;
          types?: (
              | "suggestion"
              | "problem"
              | "mapper_note"
              | "praise"
              | "hype"
              | "review")[];
      }

      Should those discussions only be unresolved problems, for example?

      • Optionalonly_unresolved?: boolean
      • Optionaltypes?: (
            | "suggestion"
            | "problem"
            | "mapper_note"
            | "praise"
            | "hype"
            | "review")[]
    • Optionalconfig: Beatmapset.Config

      How many results maximum, how to sort them, which page of those, maybe a cursor_string...

    Returns Promise<{
        beatmaps: Beatmap.Extended[];
        beatmapsets: Beatmapset.Extended[];
        cursor_string: string | null;
        discussions: WithStartingpost[];
        included_discussions: WithStartingpost[];
        reviews_config: {
            max_blocks: number;
        };
        users: WithGroups[];
    }>

    Relevant discussions and info about them

    Remarks

    (2024-03-11) For months now, the API's documentation says the response is likely to change, so beware

Settings

Member Visibility