BanEnabling

An option to enable ban users.

public enum BanEnabling

Enumeration Cases

`disabled`

Disabled for everyone.

case disabled

`enabled`

Enabled for everyone. The default timeout in minutes until the ban is automatically expired. The default reason the ban was created.

case enabled(timeoutInMinutes: Int?, reason: String?)

`enabledForModerators`

Enabled for channel members with a role of moderator or admin. The default timeout in minutes until the ban is automatically expired. The default reason the ban was created.

case enabledForModerators(timeoutInMinutes: Int?, reason: String?)

Properties

`timeoutInMinutes`

The default timeout in minutes until the ban is automatically expired.

public var timeoutInMinutes: Int?

`reason`

The default reason the ban was created.

public var reason: String?

Methods

`isEnabled(for:)`

Returns true is the ban is enabled for the channel.

public func isEnabled(for channel: ChatChannel) -> Bool

Parameters

channel: a channel.

Enumeration Cases​

disabled​

enabled​

enabledForModerators​

Properties​

timeoutInMinutes​

reason​

Methods​

isEnabled(for:)​

Parameters​

Did you find this page helpful?