Home       Trees       Index       Help   
Module hermes :: Class External
[frames | no frames]

Class External

Information about this external. The External properties object holds global information about the external that is currently running. This information is maintained by the Hermes External runtime and is read-only.

Externals may use the data property to store information that is specific to this external. This property is rarely used, as virtually all external data can (and should!) be stored in the bbs, prefs or user properties. If you do find a need to use this property, please e-mail me so that I can add your example to the documentation.

This object cannot be constructed and is instead made available in the hermes module as a global variable with the name external.
Method Summary
  __init__(self)
Do not construct this object; used the external global variable in the hermes module to access the External properties.

Instance Variable Summary
    External Data
ExternalData data: External-specific data for this external.
dict activeUsers: The list of users currently using the external.
dict users: The list of users that this external maintains data for.

Method Details

__init__(self)
(Constructor)

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

Instance Variable Details

data

External-specific data for this external.
Type:
ExternalData

activeUsers

The list of users currently using the external. This dictionary is indexed in the same manner as the bbs.users property: by user id as well as by name.
Type:
dict

users

The list of users that this external maintains data for. In other words, these User objects have external-specific data in their user.data property. If the user has accessed the external, but the external did not store any data for the user, then the user will not appear in this list. This dictionary is indexed in the same manner as the bbs.users property: by user id as well as by name.

This list can be used to determine if a user has already registered with your external. This may be necessary if you pre-populate values in the user's data object when they first enter the external. Here is one way of determining this information: 
   if user not in external.users:
       <do first-time user setup>
Type:
dict

   Home       Trees       Index       Help   
Generated by Epydoc 2.1 on Mon Mar 27 20:48:39 2006 http://epydoc.sf.net