Type Alias BanFromCommunity

BanFromCommunity: {
    ban: boolean;
    community_id: CommunityId;
    expires?: number;
    person_id: PersonId;
    reason?: string;
    remove_or_restore_data?: boolean;
}

Ban a user from a community.

Type declaration

  • ban: boolean
  • community_id: CommunityId
  • Optionalexpires?: 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
  • Optionalreason?: string
  • Optionalremove_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