Plugins.User.SubscribedUsers.ASubscribedUser Class Reference

This class represents a user that belongs to one or more groups, which are in turn subscribed to one or more channels. More...

Inheritance diagram for Plugins.User.SubscribedUsers.ASubscribedUser:

Public Member Functions
def	__init__
	Constructor. More...
def	init
	Initializer.
def	__del__
	Destructor.
def	getSubscriptionsFor
	Retrieve the user's subscriptions for the specified channels. More...
def	fetch
	Fetch the user from the data source. More...
def	has
	Determine whether or not the user has the specified access right for the specified channel. More...
def	hasAnyOf
	Determine whether or not the user has any of the specified access rights for the specified channel. More...
def	subscriptionsCategory
	Retrieve the name of the category used to search for subscription information. More...
def	Subscriptions
	Retrieve all subscriptions for the user. More...
def	subscriptionFor
	Return the subscription that allows the user to access the specified channel. More...
Public Member Functions inherited from Plugins.User.GroupedUsers.AGroupedUser
def	__init__
	Construct a new grouped user instance. More...
def	init
	Initializer.
def	__del__
	Destructor.
def	fetch
	Fetch the user from the data source. More...
def	groupCategory
	Retrieve the name of the category used to search for group information. More...
Public Member Functions inherited from Plugins.User.Users.AUser
def	__init__
	Construct a new user instance. More...
def	init
	Initializer.
def	flush
	Flush changes made to the user record back to the data source. More...
def	fetch
	Fetch the user record from the data source. More...
def	meta
	Retrieve or set the dictionary of channel metadata, or a single item from the metadata.
def	name
	Return the name of the user.

Detailed Description

This class represents a user that belongs to one or more groups, which are in turn subscribed to one or more channels.

Constructor & Destructor Documentation

def Plugins.User.SubscribedUsers.ASubscribedUser.__init__	(		Self,
			fieldsValues = None,
			params
	)

Constructor.

In addition to the paremters expected by AGroupedUser.__init__(), this routine expects that params will contain the following items:

• subscriptionsCategory – The name of the category (or table) in the data source that stores group channel subscriptions.

Member Function Documentation

def Plugins.User.SubscribedUsers.ASubscribedUser.fetch	(		Self,
			userName
	)

Fetch the user from the data source.

def Plugins.User.SubscribedUsers.ASubscribedUser.getSubscriptionsFor	(		Self,
			userName = None
	)

Retrieve the user's subscriptions for the specified channels.

def Plugins.User.SubscribedUsers.ASubscribedUser.has	(		Self,
			thisRight,
			thisChannel
	)

Determine whether or not the user has the specified access right for the specified channel.

def Plugins.User.SubscribedUsers.ASubscribedUser.hasAnyOf	(		Self,
			theseRights,
			thisChannel
	)

Determine whether or not the user has any of the specified access rights for the specified channel.

def Plugins.User.SubscribedUsers.ASubscribedUser.subscriptionFor	(		Self,
			thisChannel
	)

Return the subscription that allows the user to access the specified channel.

def Plugins.User.SubscribedUsers.ASubscribedUser.Subscriptions

(

Self

)

Retrieve all subscriptions for the user.

def Plugins.User.SubscribedUsers.ASubscribedUser.subscriptionsCategory

(

Self

)

Retrieve the name of the category used to search for subscription information.

---

The documentation for this class was generated from the following file:

• Plugins/User/SubscribedUsers.py