hermes.User

Module hermes :: Class User

Class User

Properties for the user currently accessing this external.

Externals may use the data property to store information that is specific to the user accessing the external.

This object cannot be constructed and is instead made available in the hermes module as a global variable with the name user.

Note: There are a number of other user properties accessible from this object, but they have not yet been documented.

Method Summary
	`__init__(self)` Do not construct this object; used the `user` global variable in the `hermes` module to access the User properties.
	`deleteData(self)` Delete the data for this user from the external's data store.

Instance Variable Summary
External Data
`ExternalData`	`data`: User data for this external.
User Information
`boolean`	`coSysOp`: `True` if this user has the SysOp flag set in their user record, `False` otherwise.
`int`	`dsl`: The user's download security level.
`boolean`	`hasAnsi`: `True` if the user has an ANSI display, `False` if the user only has an ASCII display and cannot render ANSI escape sequences.
`str`	`name`: The name of the user, which might be their handle if the BBS allows handles.
`boolean`	`pauseScreen`: `True` if the user wants screen pauses every `screenHeight` lines of text, `False` otherwise.
`str`	`phone`: The user's phone number.
`str`	`realName`: The user's real name.
`int`	`screenHeight`: The height of the user's screen, in lines.
`int`	`screenWidth`: The width of the user's screen, in characters.
`int`	`sl`: The user's security level.
`boolean`	`sysop`: `True` if this user is the BBS' SysOp (they have the SysOp flag and a security level of 255), `False` otherwise.
`boolean`	`useAnsiChat`: `True` if the user wants to use the ANSI chatroom, `False` to use the line-oriented chatroom.
`boolean`	`useAnsiColor`: `True` if the user's display is capable of rendering ANSI color sequences and wants to receive ANSI color sequences; `False` if the user has a black-and-white display or does not want to receive ANSI color sequences.

Method Details

init(self)
(Constructor)

Do not construct this object; used the user global variable in the hermes module to access the User properties.

deleteData(self)

Delete the data for this user from the external's data store. Cached references to the data property will still be valid, but will not reflect the contents of the on-disk storage for this user. In this way, deleteData is similar to the POSIX unlink system call.

Instance Variable Details

data

User data for this external.

Type:: ExternalData

coSysOp

True if this user has the SysOp flag set in their user record, False otherwise.

Type:: boolean

dsl

The user's download security level.

Type:: int

hasAnsi

True if the user has an ANSI display, False if the user only has an ASCII display and cannot render ANSI escape sequences.

Type:: boolean

name

The name of the user, which might be their handle if the BBS allows handles. The user's real name is accessible through the realName property.

Type:: str

pauseScreen

True if the user wants screen pauses every screenHeight lines of text, False otherwise.

Type:: boolean

phone

The user's phone number.

Type:: str

realName

The user's real name. This could be different from name if the BBS allows handles.

Type:: str

screenHeight

The height of the user's screen, in lines.

Type:: int

screenWidth

The width of the user's screen, in characters.

Type:: int

sl

The user's security level.

Type:: int

sysop

True if this user is the BBS' SysOp (they have the SysOp flag and a security level of 255), False otherwise.

Type:: boolean

useAnsiChat

True if the user wants to use the ANSI chatroom, False to use the line-oriented chatroom.

Type:: boolean

useAnsiColor

True if the user's display is capable of rendering ANSI color sequences and wants to receive ANSI color sequences; False if the user has a black-and-white display or does not want to receive ANSI color sequences.

Type:: boolean

Generated by Epydoc 2.1 on Mon Mar 27 20:48:39 2006

http://epydoc.sf.net