BanlistUser object

From StealthBot Wiki

Jump to: navigation, search

The BanlistUser object exposes a user on the internal channel ban list. A collection of BanlistUser objects are exposed by the Channel.BanlistUser property.

Contents

History

This object was added in StealthBot version 2.7 by Eric to create an object-oriented experience in scripting.

How to use

Example: Put the number of users on the banlist into the Count variable.

Count = Channel.Banlist.Count

Example: Get the value of a property of the banned user at index Index.

Value = Channel.Banlist(Index).PropertyName

Properties

List of properties

Name property

This property returns the name of the user who was banned.

DisplayName property

This property returns the display name of the user who was banned. This is affected by naming conventions.

Operator property

This property returns the name of the operator who banned the user.

DateOfBan property

This property returns the date/time of the ban.

Reason property

This property returns the reason provided for the ban.

IsDuplicateBan property

This property returns True if this ban is a duplicate ban, made by an additional operator.

IsActive property

This property returns True if this ban is still likely in affect.

See also

Personal tools