Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "yggdrasil"

Index

Interfaces

Variables

Functions

Variables

Const got

got: Got = mojang.extend({prefixUrl: "https://authserver.mojang.com",})

Functions

authenticate

  • authenticate(username: string, password: string, clientToken?: undefined | string, agent?: string): CancelableRequest<Session>

  • Authenticate a user using their password.

    see

    http://wiki.vg/Authentication#Authenticate

    Parameters

    • username: string

      Mojang account email (username for legacy accounts)

    • password: string

      Mojang account secret

    • Optional clientToken: undefined | string

      Random identifier, defaults to server-generated UUID v4

    • Default value agent: string = "Minecraft"

      Game name to start session for: Minecraft or Scrolls.

    Returns CancelableRequest<Session>

invalidate

  • invalidate(__namedParameters: { accessToken: string; clientToken: string }): Promise<void>

  • Invalidate an access token, ending only this session.

    see

    http://wiki.vg/Authentication#Invalidate

    Parameters

    • __namedParameters: { accessToken: string; clientToken: string }
      • accessToken: string
      • clientToken: string

    Returns Promise<void>

refresh

  • refresh(__namedParameters: { accessToken: string; clientToken: string }): CancelableRequest<Session>

  • Refresh a valid or recently valid access token.

    note

    An accessToken may be unusable for authentication with a Minecraft server, but still be good enough for refresh.

    see

    http://wiki.vg/Authentication#Refresh

    Parameters

    • __namedParameters: { accessToken: string; clientToken: string }
      • accessToken: string
      • clientToken: string

    Returns CancelableRequest<Session>

signout

  • signout(username: string, password: string): Promise<void>

  • Invalidates access tokens using an account's username and password.

    see

    http://wiki.vg/Authentication#Signout

    Parameters

    • username: string
    • password: string

    Returns Promise<void>

validate

  • validate(__namedParameters: { accessToken: string; clientToken: string }): Promise<boolean>

  • Check if the access token is suitable for use with a game server.

    see

    http://wiki.vg/Authentication#Validate

    Parameters

    • __namedParameters: { accessToken: string; clientToken: string }
      • accessToken: string
      • clientToken: string

    Returns Promise<boolean>

Generated using TypeDoc