Bonfire.API.MastoCompat.Schemas.List (Bonfire v1.0.1-social-alpha.28)

View Source

Schema definition for Mastodon List entity.

Mastodon Lists allow users to organize accounts they follow into named groups for creating custom timelines.

In Bonfire, Lists map to Circles.

Summary

Functions

Returns the default values for a Mastodon List.

Creates a new List map with defaults merged with provided attributes.

Required fields for a valid Mastodon List.

Validates that a List has all required fields.

Functions

defaults()

Returns the default values for a Mastodon List.

Includes Mastodon 4.x fields:

  • replies_policy: Show replies in the list timeline ("followed", "list", or "none")
  • exclusive: Whether list members are hidden from home timeline

new(attrs)

Creates a new List map with defaults merged with provided attributes.

required_fields()

Required fields for a valid Mastodon List.

validate(list)

Validates that a List has all required fields.

Returns {:ok, list} if valid, {:error, {:missing_fields, fields}} otherwise.