Function getMultiple

  • getMultiple(
        this: API,
        from?: {
            beatmapset?: number | Beatmapset;
            status?:
                | "ranked"
                | "all"
                | "qualified"
                | "disqualified"
                | "never_qualified";
            user?: number
            | User;
        },
        filter?: {
            only_unresolved?: boolean;
            types?: (
                | "suggestion"
                | "problem"
                | "mapper_note"
                | "praise"
                | "hype"
                | "review"
            )[];
        },
        config?: Beatmapset.Config,
    ): Promise<
        {
            beatmaps: Beatmap.Extended[];
            beatmapsets: Beatmapset.Extended[];
            cursor_string: null
            | string;
            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?

    • Optionalfilter: {
          only_unresolved?: boolean;
          types?: (
              "suggestion"
              | "problem"
              | "mapper_note"
              | "praise"
              | "hype"
              | "review"
          )[];
      }

      Should those discussions only be unresolved problems, for example?

    • 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: null
            | string;
            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