Type Alias Site

Site: {
    ap_id: DbUrl;
    banner?: DbUrl;
    content_warning?: string;
    description?: string;
    icon?: DbUrl;
    id: SiteId;
    inbox_url: DbUrl;
    instance_id: InstanceId;
    last_refreshed_at: string;
    name: string;
    public_key: string;
    published: string;
    sidebar?: string;
    updated?: string;
}

The site.

Type declaration

  • ap_id: DbUrl

    The federated ap_id.

  • Optionalbanner?: DbUrl

    A banner url.

  • Optionalcontent_warning?: string

    If present, nsfw content is visible by default. Should be displayed by frontends/clients when the site is first opened by a user.

  • Optionaldescription?: string

    A shorter, one-line description of the site.

  • Optionalicon?: DbUrl

    An icon URL.

  • id: SiteId
  • inbox_url: DbUrl

    The site inbox

  • instance_id: InstanceId
  • last_refreshed_at: string

    The time the site was last refreshed.

  • name: string
  • public_key: string
  • published: string
  • Optionalsidebar?: string

    A sidebar for the site in markdown.

  • Optionalupdated?: string