Options
All
  • Public
  • Public/Protected
  • All
Menu

trackmania-api-node

Index

Interfaces

Type aliases

Level 0 Functions

Other Functions

level 1 Functions

level 2 Functions

Type aliases

TrophyAchievementInfo

TrophyAchievementInfo: { duration?: undefined | number; gameMode: string; gameModeCustomData: string; isOfficial?: undefined | false | true; serverId: string; trophyAchievementId: string; trophyAchievementType: string; trophySoloMedalAchievementType: string }

Type declaration

  • Optional duration?: undefined | number
  • gameMode: string
  • gameModeCustomData: string
  • Optional isOfficial?: undefined | false | true
  • serverId: string
  • trophyAchievementId: string
  • trophyAchievementType: string
  • trophySoloMedalAchievementType: string

TrophyGainDetails

TrophyGainDetails: { level: number; previousLevel: number; rank?: undefined | number; trophyRanking?: undefined | number }

Type declaration

  • level: number
  • previousLevel: number
  • Optional rank?: undefined | number
  • Optional trophyRanking?: undefined | number

allAuthor

allAuthor: { t4Count: number }

Type declaration

  • t4Count: number

allAuthorTiers

allAuthorTiers: { t5Count: number; t6Count?: undefined | number; t7Count?: undefined | number; t8Count?: undefined | number; t9Count?: undefined | number }

Type declaration

  • t5Count: number
  • Optional t6Count?: undefined | number
  • Optional t7Count?: undefined | number
  • Optional t8Count?: undefined | number
  • Optional t9Count?: undefined | number

allBronze

allBronze: { t1Count: number }

Type declaration

  • t1Count: number

allGold

allGold: { t3Count: number }

Type declaration

  • t3Count: number

allSilver

allSilver: { t2Count: number }

Type declaration

  • t2Count: number

campaign

campaign: { categories: category[]; clubId: unknown; color: string; day: number; id: number; latestSeasons: latestSeason[]; leaderboardGroupUid: string; media: media; month: number; monthDay: number; monthYear: number; name: string; playlist: playlist[]; publicationTimestamp: number; published: boolean; publishedDate: number; seasonUid: string; useCase: number; week: number; year: number }

Type declaration

  • categories: category[]
  • clubId: unknown
  • color: string
  • day: number
  • id: number
  • latestSeasons: latestSeason[]
  • leaderboardGroupUid: string
  • media: media
  • month: number
  • monthDay: number
  • monthYear: number
  • name: string
  • playlist: playlist[]
  • publicationTimestamp: number
  • published: boolean
  • publishedDate: number
  • seasonUid: string
  • useCase: number
  • week: number
  • year: number

category

category: { length: number; name: string; position: number }

Type declaration

  • length: number
  • name: string
  • position: number

clientKey

clientKey: { id: number; key: string; timeout: number }

Type declaration

  • id: number
  • key: string
  • timeout: number

clientSettings

clientSettings: { AdsClearCacheOnExit: number; AdsMandatory: number; ClientIP: string; KillSwitch_ProfileChunk: number; KillSwitch_TitleConfig: number; KillSwitch_TitleLadder: number; KillSwitch_TitlePolicy: number; KillSwitch_TitleProfileChunk: number; KillSwitch_Xp: number; MapRecordResetTimestamp: number }

Type declaration

  • AdsClearCacheOnExit: number
  • AdsMandatory: number
  • ClientIP: string
  • KillSwitch_ProfileChunk: number
  • KillSwitch_TitleConfig: number
  • KillSwitch_TitleLadder: number
  • KillSwitch_TitlePolicy: number
  • KillSwitch_TitleProfileChunk: number
  • KillSwitch_Xp: number
  • MapRecordResetTimestamp: number

clubCampaign

clubCampaign: { activityId: number; campaign: campaign; campaignId: number; clubDecalUrl: string; clubIconUrl: string; clubId: number; creationTimestamp: number; mediaUrl: string; name: string; popularityLevel: number; publicationTimestamp: number; publishedOn: number }

Type declaration

  • activityId: number
  • campaign: campaign
  • campaignId: number
  • clubDecalUrl: string
  • clubIconUrl: string
  • clubId: number
  • creationTimestamp: number
  • mediaUrl: string
  • name: string
  • popularityLevel: number
  • publicationTimestamp: number
  • publishedOn: number

clubMember

clubMember: { accountId: string; creationDate: number; creationTimestamp: number; role: string; vip: boolean }

Type declaration

  • accountId: string
  • creationDate: number
  • creationTimestamp: number
  • role: string
  • vip: boolean

clubRoom

clubRoom: { activityId: number; campaignId: unknown; clubId: number; creationTimestamp: number; id: number; mediaUrl: string; nadeo: boolean; name: string; playerServerLogin: unknown; popularityLevel: number; room: room; roomId: number }

Type declaration

  • activityId: number
  • campaignId: unknown
  • clubId: number
  • creationTimestamp: number
  • id: number
  • mediaUrl: string
  • nadeo: boolean
  • name: string
  • playerServerLogin: unknown
  • popularityLevel: number
  • room: room
  • roomId: number

day

day: { campaignId: number; day: number; leaderboardGroup: unknown; mapUid: string; monthDay: number; relativeEnd: number; relativeStart: number; seasonUid: string }

Type declaration

  • campaignId: number
  • day: number
  • leaderboardGroup: unknown
  • mapUid: string
  • monthDay: number
  • relativeEnd: number
  • relativeStart: number
  • seasonUid: string

latestSeason

latestSeason: { active: boolean; campaignId: number; endDate: number; endTimestamp: number; name: string; relativeEnd: number; relativeStart: number; startDate: number; startTimestamp: number; uid: string }

Type declaration

  • active: boolean
  • campaignId: number
  • endDate: number
  • endTimestamp: number
  • name: string
  • relativeEnd: number
  • relativeStart: number
  • startDate: number
  • startTimestamp: number
  • uid: string

level

level: { level: top[]; zoneId: string; zoneName: string }

Type declaration

  • level: top[]
  • zoneId: string
  • zoneName: string

media

media: { buttonBackgroundUrl: string; buttonForegroundUrl: string; liveButtonBackgroundUrl: string; popUpBackgroundUrl: string; popUpImageUrl: string }

Type declaration

  • buttonBackgroundUrl: string
  • buttonForegroundUrl: string
  • liveButtonBackgroundUrl: string
  • popUpBackgroundUrl: string
  • popUpImageUrl: string

month

month: { days: day[]; lastDay: number; media: media; month: number; year: number }

Type declaration

  • days: day[]
  • lastDay: number
  • media: media
  • month: number
  • year: number

playlist

playlist: { id: number; mapUid: string; position: number }

Type declaration

  • id: number
  • mapUid: string
  • position: number

profile

profile: { idOnPlatform: string; nameOnPlatform: string; platformType: string; profileId: string; userId: string }

Type declaration

  • idOnPlatform: string
  • nameOnPlatform: string
  • platformType: string
  • profileId: string
  • userId: string

ranking

ranking: { length: number; position: number }

Type declaration

  • length: number
  • position: number

record

record: { groupUid: string; mapUid: string; score: number; zones: zone[] }

Type declaration

  • groupUid: string
  • mapUid: string
  • score: number
  • zones: zone[]

recordScore

recordScore: { respawnCount: number; score: number; time: number }

Type declaration

  • respawnCount: number
  • score: number
  • time: number

result

result: { player: string; rank: number; score: number }

Type declaration

  • player: string
  • rank: number
  • score: number

room

room: { id: number; maps: string[]; maxPlayers: number; name: string; playerCount: number; region: unknown; script: string; scriptSettings: scriptSettings; serverAccountId: string }

Type declaration

  • id: number
  • maps: string[]
  • maxPlayers: number
  • name: string
  • playerCount: number
  • region: unknown
  • script: string
  • scriptSettings: scriptSettings
  • serverAccountId: string

scriptSettings

scriptSettings: { S_DecoImageUrl_Screen16x9: { key: string; type: string; value: string }; S_ForceLapsNb: { key: string; type: string; value: string } }

Type declaration

  • S_DecoImageUrl_Screen16x9: { key: string; type: string; value: string }
    • key: string
    • type: string
    • value: string
  • S_ForceLapsNb: { key: string; type: string; value: string }
    • key: string
    • type: string
    • value: string

seasonMap

seasonMap: { mapId: string; timestamp: string }

Type declaration

  • mapId: string
  • timestamp: string

timeSlot

timeSlot: { currentMap: string; endTimestamp: number; maps: string[]; mediaUrl: string; name: string; relativeEnd: number; relativeStart: number; startTimestamp: number }

Type declaration

  • currentMap: string
  • endTimestamp: number
  • maps: string[]
  • mediaUrl: string
  • name: string
  • relativeEnd: number
  • relativeStart: number
  • startTimestamp: number

top

top: { accountId: string; position: number; score?: undefined | number; sp?: undefined | number; zoneId: string; zoneName: string }

Type declaration

  • accountId: string
  • position: number
  • Optional score?: undefined | number
  • Optional sp?: undefined | number
  • zoneId: string
  • zoneName: string

tops

tops: { top: top[]; zoneId: string; zoneName: string }

Type declaration

  • top: top[]
  • zoneId: string
  • zoneName: string

trophyHistoryData

trophyHistoryData: { accountId: string; t1Count: number; t2Count: number; t3Count: number; t4Count: number; t5Count: number; t6Count: number; t7Count: number; t8Count: number; t9Count: number; timestamp: Date; trophyAchievementInfo: TrophyAchievementInfo; trophyGainDetails: TrophyGainDetails }

Type declaration

  • accountId: string
  • t1Count: number
  • t2Count: number
  • t3Count: number
  • t4Count: number
  • t5Count: number
  • t6Count: number
  • t7Count: number
  • t8Count: number
  • t9Count: number
  • timestamp: Date
  • trophyAchievementInfo: TrophyAchievementInfo
  • trophyGainDetails: TrophyGainDetails

zone

zone: { ranking: ranking; zoneId: string; zoneName: string }

Type declaration

  • ranking: ranking
  • zoneId: string
  • zoneName: string

Level 0 Functions

Const getClientConfig

Other Functions

Const loginTrackmaniaNadeo

  • loginTrackmaniaNadeo(accessToken: string, targetAPI: string): Promise<IloginTrackmania>

Const loginTrackmaniaUbi

Const loginUbi

  • loginUbi(base64: string): Promise<IloginUbi>

  • Login to Ubisoft (level 0)

    Parameters

    • base64: string

      Base64 encoded email:password

    Returns Promise<IloginUbi>

Const refreshTokens

  • refreshTokens(refreshToken: string): Promise<Itokens>

level 1 Functions

Const getAccountZone

  • getAccountZone(accessToken: string, accountId: string): Promise<IaccountZone>

Const getMapRecords

  • getMapRecords(accessToken: string, accountId: string, mapId?: undefined | string): Promise<ImapRecords[]>

Const getMaps

  • getMaps(accessToken: string, mapUids: string[]): Promise<Imaps[]>

Const getProfiles

  • getProfiles(accessToken: string, accountIds: string[]): Promise<IwebIdentity[]>

Const getProfilesById

  • getProfilesById(accessToken: string, profileIds: string[]): Promise<Iprofiles>

Const getSeason

  • getSeason(accessToken: string, uuid: string): Promise<Iseason>

Const getServer

  • getServer(accessToken: string, uid: string): Promise<Iserver>

Const getTrophies

  • getTrophies(accessToken: string): Promise<Itrophies>

Const getTrophyCount

  • getTrophyCount(accessToken: string, accountId: string): Promise<ItrophyCount>

Const getTrophyHistory

  • getTrophyHistory(accessToken: string, accountId: string, trophyType: number, offset?: number, count?: number): Promise<ItrophyHistory>

Const getZones

  • getZones(accessToken: string): Promise<Izones[]>

level 2 Functions

Const getArcadeRooms

  • getArcadeRooms(accessToken: string): Promise<IarcadeRooms>

Const getClubCampaigns

  • getClubCampaigns(accessToken: string, offset?: number, length?: number, sort?: string, order?: string): Promise<IclubCampaigns>

  • List clubs campaigns (used when we are in Solo Screen and looking for Club Campaigns)

    Requires level 2 authentication

    Parameters

    • accessToken: string

      Access token

    • Default value offset: number = 0

      Offset (default = 0)

    • Default value length: number = 75

      Length (default = 75)

    • Default value sort: string = "popularity"

      Sort (default = 'popularity')

    • Default value order: string = "DESC"

      Order (default = 'DESC')

    Returns Promise<IclubCampaigns>

Const getClubMembers

  • getClubMembers(accessToken: string, clubId: number, offset?: number, length?: number): Promise<IclubMembers>

Const getClubRooms

  • getClubRooms(accessToken: string, offset?: number, length?: number, sort?: string, order?: string): Promise<IclubRooms>

  • This is used to obtain the clubs in the Live section of the game

    Requires level 2 authentication

    Parameters

    • accessToken: string

      Access token

    • Default value offset: number = 0

      Offset (default = 0)

    • Default value length: number = 75

      Length (default = 75)

    • Default value sort: string = "popularity"

      Sort (default = 'popularity')

    • Default value order: string = "DESC"

      Order (default = 'DESC')

    Returns Promise<IclubRooms>

Const getClubs

  • getClubs(accessToken: string, offset?: number, length?: number): Promise<Iclubs>

Const getLeaderboardsAroundScore

  • getLeaderboardsAroundScore(accessToken: string, groupUid: string, mapUid: string, score: number): Promise<ImapTopPlayer>

Const getMatchmakingRanks

  • getMatchmakingRanks(accessToken: string, profileIds: string[]): Promise<IMatchmakingRanks>

Const getMyGroupRecords

  • getMyGroupRecords(accessToken: string, groupUid: string): Promise<IgroupRecords>

Const getMyPositionGroup

  • getMyPositionGroup(accessToken: string, groupUid: string): Promise<IpositionGroup>

Const getPlayerRankings

  • getPlayerRankings(accessToken: string, accountIds: string[]): Promise<any>

Const getSeasons

  • getSeasons(accessToken: string, offset?: number, length?: number): Promise<IallSeasons>

Const getSurroundingPlayersMap

  • getSurroundingPlayersMap(accessToken: string, mapUid: string): Promise<ImapTopPlayer>

Const getTOTDs

  • getTOTDs(accessToken: string, offset?: number, length?: number): Promise<ITOTDs>

Const getTopGroupPlayersMap

  • getTopGroupPlayersMap(accessToken: string, groupUid: string, mapUid: string): Promise<ImapTopPlayer>

Const getTopPlayersGroup

  • getTopPlayersGroup(accessToken: string, groupUid: string): Promise<IgroupTopPlayers>

Const getTopPlayersMap

  • getTopPlayersMap(accessToken: string, mapUid: string): Promise<ImapTopPlayer>

Generated using TypeDoc