Interface BanUserParams

interface BanUserParams {
    ban_duration_days?: number;
    ban_reason?: string;
    delete_related_objects?: boolean;
    permanent?: boolean;
}

Index

Properties

ban_duration_days? ban_reason? delete_related_objects? permanent?

Properties

`Optional`ban_duration_days

ban_duration_days?: number

Duration of the ban in days (ignored if permanent)

Example

`Optional`ban_reason

ban_reason?: string

Reason for banning the user

Example

Fraudulent activity detected

`Optional`delete_related_objects

delete_related_objects?: boolean

Whether to delete user's related objects (tickets, comments, etc.)

Example

true

`Optional`permanent

permanent?: boolean

If true, the ban is permanent

Example

false

Interface BanUserParams

Index

Properties

Properties

`Optional`ban_duration_days

Example

`Optional`ban_reason

Example

`Optional`delete_related_objects

Example

`Optional`permanent

Example

Settings

On This Page

Interface BanUserParams

Index

Properties

Properties

Optionalban_duration_days

Example

Optionalban_reason

Example

Optionaldelete_related_objects

Example

Optionalpermanent

Example

Settings

On This Page

`Optional`ban_duration_days

`Optional`ban_reason

`Optional`delete_related_objects

`Optional`permanent