Glympse::IGroup Struct Reference

Provides access to Glympse Group object. More...

#include <IGroup.h>

Inheritance diagram for Glympse::IGroup:

Public Member Functions
virtual GString	getId ()=0
virtual int32	getState ()=0
virtual GString	getName ()=0
virtual GImage	getAvatar ()=0
virtual GArray< GGroupMember >::ptr	getMembers ()=0
	Array of current group members, sorted.
virtual GArray< GGroupMember >::ptr	getMembers (bool sorted)=0
	Array of current group members, optionally sorted.
virtual GArray< GInvite >::ptr	getInvites ()=0
	Array of pending invites.
virtual void	clearInvites ()=0
	Clears the list of invites to the group. More...
virtual GGroupMember	findMemberByUserId (const GString &userId)=0
	Looks through the list of group members and returns member whose user id matches the value passed as an argument. More...
virtual void	modify (const GString &name, const GImage &avatar)=0
	Modifies current group, allowing to add/or change the name or avatar. More...
virtual bool	send (const GInvite &invite, const GString &message)=0
	Sends group invite to new recipient. More...
virtual void	leave ()=0
	Removes self user from the group.
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

Provides access to Glympse Group object.

Member Function Documentation

virtual void Glympse::IGroup::clearInvites ( )

pure virtual

Clears the list of invites to the group.

This is used in congunction with send. Once the invites are sent, they can be cleared from the array (returned from getInvites).

virtual GGroupMember Glympse::IGroup::findMemberByUserId ( const GString &  userId)

pure virtual

Looks through the list of group members and returns member whose user id matches the value passed as an argument.

Parameters

userId

User identifier.

Returns

Group member object or NULL, if corresponding member is not found.

virtual GImage Glympse::IGroup::getAvatar ( )

pure virtual

Returns

Gets group avatar or NULL if it is not set.

virtual GString Glympse::IGroup::getId ( )

pure virtual

Returns

Gets group identifier.

virtual GString Glympse::IGroup::getName ( )

pure virtual

Returns

Gets group name or NULL if it is not set.

virtual int32 Glympse::IGroup::getState ( )

pure virtual

Returns

Gets group state. See GlympseConstants for details.

virtual void Glympse::IGroup::modify ( const GString &  name, const GImage &  avatar  )

pure virtual

Modifies current group, allowing to add/or change the name or avatar.

NULL value keeps corresponding property unchanged.

virtual bool Glympse::IGroup::send ( const GInvite &  invite, const GString &  message  )

pure virtual

Sends group invite to new recipient.

Parameters

invite	Invite object to be sent.
message	Optional message to be sent along with the invite.

Returns

Returns true, if invite was scheduled to be sent.

---

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

• IGroup.h