Glympse::ICardType Struct Reference

Exposes basic properties for types of cards. More...

#include <ICardType.h>

Inheritance diagram for Glympse::ICardType:

Public Member Functions
virtual GString	getId ()=0
virtual GString	getName ()=0
virtual GString	getCategory ()=0
virtual GString	getDescription ()=0
virtual GArray< GPrimitive >::ptr	getNotifications ()=0
	Gets the list of notifications supported by cards of current type. More...
virtual GPrimitive	findNotificationByType (const GString &type)=0
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

Exposes basic properties for types of cards.

Host application does not create or modify card type objects directly. Instead it uses methods exposed by ICardManager.

Member Function Documentation

virtual GPrimitive Glympse::ICardType::findNotificationByType ( const GString &  type)

pure virtual

Parameters

type	Card notification type.

Returns

Card notification type of NULL if it is not found.

virtual GString Glympse::ICardType::getCategory ( )

pure virtual

Returns

Gets card type category.

virtual GString Glympse::ICardType::getDescription ( )

pure virtual

Returns

Gets card type description.

virtual GString Glympse::ICardType::getId ( )

pure virtual

Returns

Gets card type ID.

virtual GString Glympse::ICardType::getName ( )

pure virtual

Returns

Gets card type name.

virtual GArray<GPrimitive>::ptr Glympse::ICardType::getNotifications ( )

pure virtual

Gets the list of notifications supported by cards of current type.

Each notification primitive has the following properties:

• type: string
• presenter: string

The following notification types are supported:

• member_added
• member_removed
• member_started_sharing
• member_started_requesting
• invite_added
• invite_removed

Note

Some notification types may be omitted from the list leaving host application in charge of picking the most appropriate mechanism for presenting those.

The following presenter options are avaialble:

• app - application is supposed to render local notification;
• sdk - SDK does what it takes to notify the user;
• os - user is notified via remote notification.

Returns

The list of card type notifications.

---

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

• ICardType.h