Revision as of 16:11, 12 February 2013

GroupServer has many objects, interfaces, and components. This page serves as an incomplete list and quick reference of the data structures of GroupServer. In many cases, a brief description of the structure's purpose and listing of its properties/methods is provided. In general, the EGG-INFO/PKG-INFO of the structure's egg will provide much more detail, and will probably be more current. And of course, there's the code itself.

Groups, Group, and GroupMembers

GSGroupsInfo

Provides info/access for all groups on the site, and creates lists of groups based on user membership.

.get_all_groups()

.get_visible_groups() - Returns all groups visible to the logged in user

.get_visible_group_ids() - Returns ids of .get_visible_groups()

.filter_visible_groups_id(gIds)

.clear_groups_cache()

.get_non_member_groups_for_user(user)

.get_joinable_groups_for_user(user)

.get_joinable_group_ids_for_user(user)

.get_member_groups_for_user(user, authUser=None) - Returns a list of groups the user is a member of. If "user" is the same as the "authenticatedUser", then the list will be of all groups that "user" is a member of. Otherwise only the groups that the user is a member of, and has posted to, will be listed.

IGSGroupInfo

Package: Products.GSGroup.interfaces.IGSGroupInfo

Declares basic properties of a group:

group_exists()

get_id()

get_name()

get_url()

get_property(prop, default)

GSGroupInfo

Package: Products.GSGroup.groupInfo.GSGroupInfo

ZCA Name: groupserver.GroupInfo

Implements IGSGroupInfo and provides the following constructor:

__init__(self, context, groupId=None): If no groupId, the group will be figured out by acquisition.

Additional properties/methods provided:

description

relativeURL

group_type

ptn_coach

group_admins

group_stats

group_members_info - an instance of Products.GSGroupMember.groupMembersInfo.GSGroupMembersInfo

site_admins

joinability

IGSGroupMembersInfo

Package: Products.GSGroupMember.interfaces.IGSGroupMembersInfo

Declares properties related to the set (and subsets) of members of a group.