GameServer.Friends (game_server_sdk v0.1.0)

View Source

Friends context - handles friend requests and relationships.

Basic semantics:

  • A single friendships row represents a directed request from requester -> target.

  • status: "pending" | "accepted" | "rejected" | "blocked"

  • When a user accepts a pending incoming request, that request becomes accepted. If a reverse pending request exists, it will be removed to avoid duplicate rows.
  • Listing friends returns the other user from rows with status accepted in either direction.

Usage

# Create a friend request (requester -> target)
{:ok, friendship} = GameServer.Friends.create_request(requester_id, target_id)

# Accept a pending incoming request (performed by the target)
{:ok, accepted} = GameServer.Friends.accept_friend_request(friendship.id, %GameServer.Accounts.User{id: target_id})

# List accepted friends for a user (paginated)
friends = GameServer.Friends.list_friends_for_user(user_id, page: 1, page_size: 25)

# Count accepted friends for a user
count = GameServer.Friends.count_friends_for_user(user_id)

# Remove a friendship (either direction)
{:ok, _} = GameServer.Friends.remove_friend(user_id, friend_id)

Note: This is an SDK stub. Calling these functions will raise an error. The actual implementation runs on the GameServer.

Summary

Functions

accept_friend_request(friendship_id, user)

Accept a friend request (only the target may accept). Returns {:ok, friendship}.

create_request(requester_id, target_id)

Create a friend request from requester -> target.

list_friends_for_user(user_id, opts)

List accepted friends for a given user id - returns list of User structs.

list_incoming_requests(user_id, opts)

List incoming pending friend requests for a user (Friendship structs).

list_outgoing_requests(user_id, opts)

List outgoing pending friend requests for a user (Friendship structs).

reject_friend_request(friendship_id, user)

Reject a friend request (only the target may reject). Returns {:ok, friendship}.

Functions

accept_friend_request(friendship_id, user)

@spec accept_friend_request(integer(), GameServer.Accounts.User.t()) ::
  {:ok, GameServer.Friends.Friendship.t()} | {:error, term()}

Accept a friend request (only the target may accept). Returns {:ok, friendship}.

create_request(requester_id, target_id)

@spec create_request(GameServer.Accounts.User.t() | integer(), integer()) ::
  {:ok, GameServer.Friends.Friendship.t()} | {:error, any()}

Create a friend request from requester -> target.

If a reverse pending request exists (target -> requester) it will be accepted instead.
Returns {:ok, friendship} on success or {:error, reason}.

list_friends_for_user(user_id, opts)

@spec list_friends_for_user(
  integer() | GameServer.Accounts.User.t(),
  GameServer.Types.pagination_opts()
) :: [GameServer.Accounts.User.t()]

List accepted friends for a given user id - returns list of User structs.

## Options

See GameServer.Types.pagination_opts/0 for available options.

list_incoming_requests(user_id, opts)

@spec list_incoming_requests(
  integer() | GameServer.Accounts.User.t(),
  GameServer.Types.pagination_opts()
) :: [GameServer.Friends.Friendship.t()]

List incoming pending friend requests for a user (Friendship structs).

## Options

See GameServer.Types.pagination_opts/0 for available options.

list_outgoing_requests(user_id, opts)

@spec list_outgoing_requests(
  integer() | GameServer.Accounts.User.t(),
  GameServer.Types.pagination_opts()
) :: [GameServer.Friends.Friendship.t()]

List outgoing pending friend requests for a user (Friendship structs).

## Options

See GameServer.Types.pagination_opts/0 for available options.

reject_friend_request(friendship_id, user)

@spec reject_friend_request(integer(), GameServer.Accounts.User.t()) ::
  {:ok, GameServer.Friends.Friendship.t()} | {:error, term()}

Reject a friend request (only the target may reject). Returns {:ok, friendship}.