GameServer.Accounts.User (game_server_sdk v1.0.951)

Copy Markdown View Source

User struct from GameServer.

This is a stub module for SDK type definitions. The actual struct is provided by GameServer at runtime.

Fields

  • id - User ID (integer)
  • email - User email (string)
  • display_name - Display name (string, optional)
  • profile_url - Profile URL/avatar (string, optional)
  • metadata - Arbitrary user metadata (map)
  • is_admin - Whether the user is an admin (boolean)
  • is_online - Whether the user is currently online (boolean)
  • last_seen_at - Last seen timestamp (DateTime, optional)
  • lobby_id - Current lobby ID (integer, optional)
  • party_id - Current party ID (integer, optional)
  • inserted_at - Creation timestamp
  • updated_at - Last update timestamp

Summary

Types

t()

Functions

email_changeset(user, attrs, opts)

Builds an email change changeset for a user.

password_changeset(user, attrs, opts)

Builds a password change changeset for a user.

Types

t()

@type t() :: %GameServer.Accounts.User{
  display_name: String.t() | nil,
  email: String.t() | nil,
  id: integer() | nil,
  inserted_at: DateTime.t(),
  is_admin: boolean(),
  is_online: boolean(),
  last_seen_at: DateTime.t() | nil,
  lobby_id: integer() | nil,
  metadata: map(),
  party_id: integer() | nil,
  profile_url: String.t() | nil,
  updated_at: DateTime.t()
}

Functions

email_changeset(user, attrs, opts)

@spec email_changeset(t(), map(), keyword()) :: no_return()

Builds an email change changeset for a user.

This function exists in the real GameServer implementation. In the SDK it is provided as a stub so documentation references can resolve.

password_changeset(user, attrs, opts)

@spec password_changeset(t(), map(), keyword()) :: no_return()

Builds a password change changeset for a user.

This function exists in the real GameServer implementation. In the SDK it is provided as a stub so documentation references can resolve.