Represents a Ban issued to a user. Provides helper methods to easily lift the ban directly from the entity instance.
Instantiates a new BanEntity.
The active SDK client instance.
The raw ban data from the API.
Ban.active
Ban.bannedAt
Ban.expiresAt
Ban.id
Ban.reason
Ban.staffer
Ban.unbannedAt
Ban.unbannedBy
Ban.unbanReason
Ban.userId
Lifts this ban directly.
The unban details (staffer ID and optional reason).
A promise resolving when the ban is successfully lifted.
await ban.unban({ unbannedBy: 'Admin1', unbanReason: 'Appeal accepted' }); Copy
await ban.unban({ unbannedBy: 'Admin1', unbanReason: 'Appeal accepted' });
Represents a Ban issued to a user. Provides helper methods to easily lift the ban directly from the entity instance.