Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Clans

Hierarchy

  • Clans

Index

Constructors

Properties

Methods

Constructors

constructor

  • Class that handles base of Clans

    Parameters

    Returns Clans

Properties

Private api

Methods

getClan

  • getClan(clanTag: string): Promise<Clan>
  • Get clan information

    Parameters

    • clanTag: string

      Tag of the clan

    Returns Promise<Clan>

searchClans

  • Search clans

    description

    Search all clans by name and/or filtering the results using various criteria. At least one filtering criteria must be defined and if name is used as part of search, it is required to be at least three characters long. It is not possible to specify ordering for results so clients should not rely on any specific ordering as that may change in the future releases of the API.

    Parameters

    • searchOptions: ClanSearchOptions

      clan search options, at least one option is required

    Returns Promise<Clan[]>

Made by Horyus. Documentation generated by TypeDoc.