lemmy-js-client
    Preparing search index...

    Type Alias BanFromCommunity

    Ban a user from a community.

    type BanFromCommunity = {
        ban: boolean;
        community_id: CommunityId;
        expires_at?: number;
        person_id: PersonId;
        reason?: string;
        remove_or_restore_data?: boolean;
    }
    Index

    Properties

    ban community_id expires_at? person_id reason? remove_or_restore_data?

    Properties

    ban: boolean
    community_id: CommunityId
    expires_at?: number

    A time that the ban will expire, in unix epoch seconds.

    An i64 unix timestamp is used for a simpler API client implementation.

    person_id: PersonId
    reason?: string
    remove_or_restore_data?: boolean

    Optionally remove or restore all their data. Useful for new troll accounts. If ban is true, then this means remove. If ban is false, it means restore.

    Settings

    Member Visibility

    On This Page

    Properties