Type Alias Community

Community: {
    ap_id: DbUrl;
    banner?: DbUrl;
    deleted: boolean;
    description?: string;
    hidden: boolean;
    icon?: DbUrl;
    id: CommunityId;
    instance_id: InstanceId;
    local: boolean;
    name: string;
    nsfw: boolean;
    posting_restricted_to_mods: boolean;
    published: string;
    removed: boolean;
    sidebar?: string;
    title: string;
    updated?: string;
    visibility: CommunityVisibility;
}

A community.

Type declaration

  • ap_id: DbUrl

    The federated ap_id.

  • Optionalbanner?: DbUrl

    A URL for a banner.

  • deleted: boolean

    Whether the community has been deleted by its creator.

  • Optionaldescription?: string

    A shorter, one-line description of the site.

  • hidden: boolean

    Whether the community is hidden.

  • Optionalicon?: DbUrl

    A URL for an icon.

  • id: CommunityId
  • instance_id: InstanceId
  • local: boolean

    Whether the community is local.

  • name: string
  • nsfw: boolean

    Whether its an NSFW community.

  • posting_restricted_to_mods: boolean

    Whether posting is restricted to mods only.

  • published: string
  • removed: boolean

    Whether the community is removed by a mod.

  • Optionalsidebar?: string

    A sidebar for the community in markdown.

  • title: string

    A longer title, that can contain other characters, and doesn't have to be unique.

  • Optionalupdated?: string
  • visibility: CommunityVisibility

Settings

Member Visibility