Class YggdrasilThirdPartyClient

🏭 Constructors

constructor

YggdrasilThirdPartyClient(api: string, options: YggdrasilClientOptions): YggdrasilThirdPartyClient

Create thirdparty (authlib-injector) style client

Parameters

• api: string The api url following https://github.com/yushijinhun/authlib-injector/wiki/Yggdrasil-服务端技术规范
• options: YggdrasilClientOptions

Return Type

• YggdrasilThirdPartyClient

Defined in: packages/user/yggdrasil.ts:237

🏷️ Properties

api public

api: string

The official-like api endpoint Inherited from: YggdrasilClient.api

Defined in: packages/user/yggdrasil.ts:106

fetch protected

fetch: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>

Inherited from: YggdrasilClient.fetch

Defined in: packages/user/yggdrasil.ts:98

File protected

File: (fileBits: BlobPart[], fileName: string, options?: FilePropertyBag) => File

Inherited from: YggdrasilClient.File

Defined in: packages/user/yggdrasil.ts:100

FormData protected

FormData: (form?: HTMLFormElement, submitter?: null | HTMLElement) => FormData

Inherited from: YggdrasilClient.FormData

Defined in: packages/user/yggdrasil.ts:99

headers protected

headers: Record<string, string>

Inherited from: YggdrasilClient.headers

Defined in: packages/user/yggdrasil.ts:97

profileApi public

profileApi: string

Defined in: packages/user/yggdrasil.ts:229

textureApi public

textureApi: string

Defined in: packages/user/yggdrasil.ts:230

🔧 Methods

invalidate

invalidate(accessToken: string, clientToken: string, signal: AbortSignal): Promise<boolean>

Parameters

• accessToken: string
• clientToken: string
• signal: AbortSignal

Return Type

• Promise<boolean>

Inherited from: YggdrasilClient.invalidate

Defined in: packages/user/yggdrasil.ts:126

login

login(__namedParameters: { clientToken: string; password: string; requestUser?: boolean; username: string }, signal: AbortSignal): Promise<YggrasilAuthentication>

Parameters

• __namedParameters: { clientToken: string; password: string; requestUser?: boolean; username: string }
• signal: AbortSignal

Return Type

• Promise<YggrasilAuthentication>

Inherited from: YggdrasilClient.login

Defined in: packages/user/yggdrasil.ts:138

lookup

lookup(uuid: string, unsigned: boolean= true, signal: AbortSignal): Promise<GameProfileWithProperties>

Parameters

• uuid: string
• unsigned: boolean
• signal: AbortSignal

Return Type

• Promise<GameProfileWithProperties>

Defined in: packages/user/yggdrasil.ts:249

refresh

refresh(__namedParameters: { accessToken: string; clientToken: string; requestUser?: boolean }, signal: AbortSignal): Promise<YggrasilAuthentication>

Parameters

• __namedParameters: { accessToken: string; clientToken: string; requestUser?: boolean }
• signal: AbortSignal

Return Type

• Promise<YggrasilAuthentication>

Inherited from: YggdrasilClient.refresh

Defined in: packages/user/yggdrasil.ts:164

setTexture

setTexture(options: SetTextureOption, signal: AbortSignal): Promise<void>

Parameters

• options: SetTextureOption
• signal: AbortSignal

Return Type

• Promise<void>

Defined in: packages/user/yggdrasil.ts:278

validate

validate(accessToken: string, clientToken: string, signal: AbortSignal): Promise<boolean>

Parameters

• accessToken: string
• clientToken: string
• signal: AbortSignal

Return Type

• Promise<boolean>

Inherited from: YggdrasilClient.validate

Defined in: packages/user/yggdrasil.ts:113