Skip to content
Last Updated
Mar 28, 2025, 03:08

Interface GameProfileWithProperties ​

The game profile of the user.

In auth response, it will usually carry the userId, createdAt properties.

In lookup function, it will carry the properties property.

🏷️ Properties ​

createdAt optional ​

ts
createdAt: number

Inherited from: GameProfile.createdAt

Defined in: packages/user/gameProfile.ts:19

id ​

ts
id: string

game profile unique id Inherited from: GameProfile.id

Defined in: packages/user/gameProfile.ts:12

legacy optional ​

ts
legacy: boolean

Inherited from: GameProfile.legacy

Defined in: packages/user/gameProfile.ts:24

legacyProfile optional ​

ts
legacyProfile: boolean

Inherited from: GameProfile.legacyProfile

Defined in: packages/user/gameProfile.ts:20

migrated optional ​

ts
migrated: boolean

Inherited from: GameProfile.migrated

Defined in: packages/user/gameProfile.ts:23

name ​

ts
name: string

This is in game displayed name Inherited from: GameProfile.name

Defined in: packages/user/gameProfile.ts:16

ts
paid: boolean

Inherited from: GameProfile.paid

Defined in: packages/user/gameProfile.ts:22

properties ​

ts
properties: (name: string) => string

Defined in: packages/user/gameProfile.ts:28

suspended optional ​

ts
suspended: boolean

Inherited from: GameProfile.suspended

Defined in: packages/user/gameProfile.ts:21

userId optional ​

ts
userId: string

Inherited from: GameProfile.userId

Defined in: packages/user/gameProfile.ts:18