lemmy-js-client
    Preparing search index...

    Type Alias EditSite

    Edits a site.

    type EditSite = {
        application_email_admins?: boolean;
        application_question?: string;
        blocked_urls?: string[];
        captcha_difficulty?: string;
        captcha_enabled?: boolean;
        comment_downvotes?: FederationMode;
        comment_upvotes?: FederationMode;
        community_creation_admin_only?: boolean;
        content_warning?: string;
        default_comment_sort_type?: CommentSortType;
        default_items_per_page?: number;
        default_post_listing_mode?: PostListingMode;
        default_post_listing_type?: ListingType;
        default_post_sort_type?: PostSortType;
        default_post_time_range_seconds?: number;
        default_theme?: string;
        description?: string;
        disable_email_notifications?: boolean;
        disallow_nsfw_content?: boolean;
        discussion_languages?: LanguageId[];
        federation_enabled?: boolean;
        legal_information?: string;
        name?: string;
        oauth_registration?: boolean;
        post_downvotes?: FederationMode;
        post_upvotes?: FederationMode;
        private_instance?: boolean;
        rate_limit_comment_interval_seconds?: number;
        rate_limit_comment_max_requests?: number;
        rate_limit_image_interval_seconds?: number;
        rate_limit_image_max_requests?: number;
        rate_limit_import_user_settings_interval_seconds?: number;
        rate_limit_import_user_settings_max_requests?: number;
        rate_limit_message_interval_seconds?: number;
        rate_limit_message_max_requests?: number;
        rate_limit_post_interval_seconds?: number;
        rate_limit_post_max_requests?: number;
        rate_limit_register_interval_seconds?: number;
        rate_limit_register_max_requests?: number;
        rate_limit_search_interval_seconds?: number;
        rate_limit_search_max_requests?: number;
        registration_mode?: RegistrationMode;
        reports_email_admins?: boolean;
        require_email_verification?: boolean;
        sidebar?: string;
        slur_filter_regex?: string;
        suggested_communities?: MultiCommunityId;
    }
    Index

    Properties

    application_email_admins? application_question? blocked_urls? captcha_difficulty? captcha_enabled? comment_downvotes? comment_upvotes? community_creation_admin_only? content_warning? default_comment_sort_type? default_items_per_page? default_post_listing_mode? default_post_listing_type? default_post_sort_type? default_post_time_range_seconds? default_theme? description? disable_email_notifications? disallow_nsfw_content? discussion_languages? federation_enabled? legal_information? name? oauth_registration? post_downvotes? post_upvotes? private_instance? rate_limit_comment_interval_seconds? rate_limit_comment_max_requests? rate_limit_image_interval_seconds? rate_limit_image_max_requests? rate_limit_import_user_settings_interval_seconds? rate_limit_import_user_settings_max_requests? rate_limit_message_interval_seconds? rate_limit_message_max_requests? rate_limit_post_interval_seconds? rate_limit_post_max_requests? rate_limit_register_interval_seconds? rate_limit_register_max_requests? rate_limit_search_interval_seconds? rate_limit_search_max_requests? registration_mode? reports_email_admins? require_email_verification? sidebar? slur_filter_regex? suggested_communities?

    Properties

    application_email_admins?: boolean

    Whether to email admins when receiving a new application.

    application_question?: string

    Your application question form. This is in markdown, and can be many questions.

    blocked_urls?: string[]

    A list of blocked URLs

    captcha_difficulty?: string

    The captcha difficulty. Can be easy, medium, or hard

    captcha_enabled?: boolean

    Whether to enable captchas for signups.

    comment_downvotes?: FederationMode

    What kind of comment downvotes your site allows.

    comment_upvotes?: FederationMode

    What kind of comment upvotes your site allows.

    community_creation_admin_only?: boolean

    Limits community creation to admins only.

    Optionalcontent_warning

    content_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.

    default_comment_sort_type?: CommentSortType

    The default comment sort, usually "hot"

    Optionaldefault_items_per_page

    default_items_per_page?: number

    A default fetch limit for number of items returned.

    Optionaldefault_post_listing_mode

    default_post_listing_mode?: PostListingMode

    Default value for listing mode, usually "list"

    Optionaldefault_post_listing_type

    default_post_listing_type?: ListingType

    The default post listing type, usually "local"

    Optionaldefault_post_sort_type

    default_post_sort_type?: PostSortType

    The default post sort, usually "active"

    Optionaldefault_post_time_range_seconds

    default_post_time_range_seconds?: number

    A default time range limit to apply to post sorts, in seconds. 0 means none.

    default_theme?: string

    The default theme. Usually "browser"

    description?: string

    A shorter, one line description of your site.

    disable_email_notifications?: boolean

    Dont send email notifications to users for new replies, mentions etc

    Optionaldisallow_nsfw_content

    disallow_nsfw_content?: boolean

    Block NSFW content being created

    discussion_languages?: LanguageId[]

    A list of allowed discussion languages.

    federation_enabled?: boolean

    Whether to enable federation.

    legal_information?: string

    An optional page of legal information

    name?: string
    oauth_registration?: boolean

    Whether or not external auth methods can auto-register users.

    Optionalpost_downvotes

    post_downvotes?: FederationMode

    What kind of post downvotes your site allows.

    Optionalpost_upvotes

    post_upvotes?: FederationMode

    What kind of post upvotes your site allows.

    private_instance?: boolean

    Whether your instance is public, or private.

    rate_limit_comment_interval_seconds?: number
    rate_limit_comment_max_requests?: number

    The number of comments allowed in a given time frame.

    rate_limit_image_interval_seconds?: number
    rate_limit_image_max_requests?: number

    The number of image uploads allowed in a given time frame.

    rate_limit_import_user_settings_interval_seconds?: number
    rate_limit_import_user_settings_max_requests?: number

    The number of settings imports or exports allowed in a given time frame.

    rate_limit_message_interval_seconds?: number
    rate_limit_message_max_requests?: number

    The number of messages allowed in a given time frame.

    Optionalrate_limit_post_interval_seconds

    rate_limit_post_interval_seconds?: number

    Optionalrate_limit_post_max_requests

    rate_limit_post_max_requests?: number

    The number of posts allowed in a given time frame.

    rate_limit_register_interval_seconds?: number
    rate_limit_register_max_requests?: number

    The number of registrations allowed in a given time frame.

    rate_limit_search_interval_seconds?: number
    rate_limit_search_max_requests?: number

    The number of searches allowed in a given time frame.

    registration_mode?: RegistrationMode
    reports_email_admins?: boolean

    Whether to email admins for new reports.

    require_email_verification?: boolean

    Whether to require email verification.

    sidebar?: string

    A sidebar for the site, in markdown.

    slur_filter_regex?: string

    A regex string of items to filter.

    suggested_communities?: MultiCommunityId

    A multicommunity with suggested communities which is shown on the homepage

    Settings

    Member Visibility

    On This Page

    Properties
    application_email_adminsapplication_questionblocked_urlscaptcha_difficultycaptcha_enabledcomment_downvotescomment_upvotescommunity_creation_admin_onlycontent_warningdefault_comment_sort_typedefault_items_per_pagedefault_post_listing_modedefault_post_listing_typedefault_post_sort_typedefault_post_time_range_secondsdefault_themedescriptiondisable_email_notificationsdisallow_nsfw_contentdiscussion_languagesfederation_enabledlegal_informationnameoauth_registrationpost_downvotespost_upvotesprivate_instancerate_limit_comment_interval_secondsrate_limit_comment_max_requestsrate_limit_image_interval_secondsrate_limit_image_max_requestsrate_limit_import_user_settings_interval_secondsrate_limit_import_user_settings_max_requestsrate_limit_message_interval_secondsrate_limit_message_max_requestsrate_limit_post_interval_secondsrate_limit_post_max_requestsrate_limit_register_interval_secondsrate_limit_register_max_requestsrate_limit_search_interval_secondsrate_limit_search_max_requestsregistration_modereports_email_adminsrequire_email_verificationsidebarslur_filter_regexsuggested_communities