Skip to content

Type Alias: BanFromCommunity

ts
type BanFromCommunity = object;

Defined in: src/types/BanFromCommunity.ts:4

Ban a user from a community.

Properties

PropertyTypeDescriptionDefined in
banboolean-src/types/BanFromCommunity.ts:5
community_idnumber-src/types/BanFromCommunity.ts:6
expires_at?numberA time that the ban will expire, in unix epoch seconds. An i64 unix timestamp is used for a simpler API client implementation.src/types/BanFromCommunity.ts:12
person_idnumber-src/types/BanFromCommunity.ts:13
reason?string-src/types/BanFromCommunity.ts:14
remove_or_restore_data?booleanOptionally 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.src/types/BanFromCommunity.ts:19