All Classes Functions Variables Typedefs Friends Pages
Public Member Functions | List of all members
Glympse::IGroupManager Struct Referenceabstract

Contains a collection of Group objects. More...

#include <IGroupManager.h>

Inheritance diagram for Glympse::IGroupManager:
Inheritance graph
[legend]

Public Member Functions

virtual bool isSynced ()=0
 Determines whether or not the state of all public groups to which the user belongs has beeen synchronized with the server. More...
 
virtual bool isValidGroup (const GString &name)=0
 Checks group name for correctness. More...
 
virtual int32 validateGroupName (const GString &name)=0
 Checks group name for correctness. More...
 
virtual GGroup viewGroup (const GString &name)=0
 Starts viewing public group with specified name. More...
 
virtual GArray< GGroup >::ptr getGroups ()=0
 Returns the group list collection as an array of IGroup objects.
 
virtual GGroup findGroupByGroupId (const GString &groupId)=0
 Gets the Group object that matches the given group ID. More...
 
virtual bool anyActive ()=0
 
virtual GEnumeration< GGroup >::ptr getTracking ()=0
 Returns the active group list collection as an array of IGroup objects.
 
virtual int32 startTracking (const GGroup &group)=0
 Marks specific group as active.
 
virtual int32 stopTracking (const GGroup &group)=0
 Marks specific group as not active.
 
virtual void startTrackingAll ()=0
 Activate all groups on the list. More...
 
virtual void stopTrackingAll (bool forced)=0
 Deactivate all groups on the list. More...
 
virtual bool anyActiveTracked ()=0
 
virtual bool isTracking (const GGroup &group)=0
 
- Public Member Functions inherited from Glympse::IEventSink
virtual bool addListener (const GEventListener &eventListener)=0
 Registeres event listener on the sink. More...
 
virtual bool removeListener (const GEventListener &eventListener)=0
 Unsubscribes listener from events coming from this sink.
 
virtual GArray< GEventListener >
::ptr 
getListeners ()=0
 Provides access to the collection of current listeners. More...
 
virtual bool hasContext (int64 key)=0
 Checks, where user context identified by key is already associated with the object.
 
virtual void associateContext (int64 key, const GCommonObj &value)=0
 Associates specific context (user data) with the sink. More...
 
virtual GCommonObj getContext (int64 key)=0
 Returns context associated with the sink, or NULL, if it is not found.
 
virtual void clearContext (int64 key)=0
 Clears context identified by key argument.
 
virtual GEnumeration< GLong >::ptr getContextKeys ()=0
 Gets enumeration of all context keys associated with the sink.
 
virtual void deriveContext (const GEventSink &sink)=0
 Derives context from another sink object.
 
- Public Member Functions inherited from Glympse::IEventListener
virtual void eventsOccurred (const GGlympse &glympse, int32 listener, int32 events, const GCommonObj &obj)=0
 This method is invoked each time, when sink object notifies subscriber on an event. More...
 
- Public Member Functions inherited from Glympse::ICommon
virtual int32 retain ()=0
 Add a reference to our object in a COM-like way.
 
virtual int32 release ()=0
 Release a reference to our object in a COM-like way.
 
virtual int32 hold ()=0
 Add a reference to our object in a COM-like way.
 
virtual int32 unhold ()=0
 Release a reference to our object in a COM-like way.
 
virtual int32 hashCode ()=0
 Returns an integer hash code for this object.
 
virtual bool equals (const GCommonObj &o)=0
 Compares this instance with the specified object and indicates if they are equal. More...
 
virtual GString toString ()=0
 Returns a string containing a concise, human-readable description of this object. More...
 
virtual void attachObject (const GCommon &obj)=0
 Asociates arbitrary object with the instance.
 
virtual GCommon extractObject ()=0
 Extracts associated object or NULL if no association is established.
 

Additional Inherited Members

- Protected Member Functions inherited from Glympse::ICommon
virtual ~ICommon ()
 Destructor is protected to deny explicit object deallocation. More...
 

Detailed Description

Contains a collection of Group objects.

Active groups are currently tracked by the user. Glympse API only queries details of active groups to minimize bandwidth and achieve best performance. Platform still queries some basic data for all groups to present activity alerts even for not active groups. Note that this concept has nothing to do with user participation in those groups.

See Also
IGroup
IGroupMember
IUser
ITicket

Member Function Documentation

virtual bool Glympse::IGroupManager::anyActive ( )
pure virtual
Returns
true, if there are any initialized groups on the system. The method ignores the first group, which is formed by standalone users.
virtual bool Glympse::IGroupManager::anyActiveTracked ( )
pure virtual
Returns
true, if there are any initialized groups tracked by user on the system. The method ignores the first group, which is formed by standalone users.
virtual GGroup Glympse::IGroupManager::findGroupByGroupId ( const GString groupId)
pure virtual

Gets the Group object that matches the given group ID.

Parameters
groupIdGroup ID of the ticket you would like to find.
Returns
The Group object that matches the given group ID, or NULL if the group ID was not found.
virtual bool Glympse::IGroupManager::isSynced ( )
pure virtual

Determines whether or not the state of all public groups to which the user belongs has beeen synchronized with the server.

Upon completion, the GroupManager also sends the GE::GROUPS_SYNCED_WITH_SERVER event.

Returns
true, if the state of all public groups has finished syncing.
virtual bool Glympse::IGroupManager::isTracking ( const GGroup group)
pure virtual
Returns
true, if group is being tracked.
virtual bool Glympse::IGroupManager::isValidGroup ( const GString name)
pure virtual

Checks group name for correctness.

See validateGroupName() for the list of rules applied to group names.

Returns
true, if valid group name is specified.
virtual void Glympse::IGroupManager::startTrackingAll ( )
pure virtual

Activate all groups on the list.

This tool is useful for displaying "World View" with all active tickets in a single place. It is required to decode all groups for this purpose.

virtual void Glympse::IGroupManager::stopTrackingAll ( bool  forced)
pure virtual

Deactivate all groups on the list.

This tool should be used, when user returns to the list of groups. So none of them is active any more.

virtual int32 Glympse::IGroupManager::validateGroupName ( const GString name)
pure virtual

Checks group name for correctness.

The following rules are applied to group names:

  • Letters and digits are allowed.
  • Group name can start with either '!' or '#' symbol.
  • Group names do not support spaces.
  • Special characters like “!, #, $, %, ^, &, *, +, .” are not allowed.
  • The only allowed symbol is underscore (‘_’).
  • Group names cannot consist of just digits. At least single letter is required.
  • Group name length is limited to 256 characters.
  • Group names are case insensitive.
Returns
One of GC::GROUP_NAME_* values is returned.
virtual GGroup Glympse::IGroupManager::viewGroup ( const GString name)
pure virtual

Starts viewing public group with specified name.

Parameters
nameGroup name.

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