diff -r 4b1e636e8a71 -r 86af6c333601 example/clientapi/smf/inc/smfclient/smfpostprovider.h --- a/example/clientapi/smf/inc/smfclient/smfpostprovider.h Thu Mar 25 14:44:08 2010 +0530 +++ b/example/clientapi/smf/inc/smfclient/smfpostprovider.h Tue Apr 06 16:35:37 2010 +0530 @@ -1,29 +1,33 @@ -/* -* Copyright (c) 2010 Sasken Communication Technologies Ltd. -* All rights reserved. -* This component and the accompanying materials are made available -* under the terms of the "{License}" -* which accompanies this distribution, and is available -* at the URL "{LicenseUrl}". -* -* Initial Contributors: -* Chandradeep Gandhi, Sasken Communication Technologies Ltd - Initial contribution -* -* Contributors: -* -* Description: -* Interface spefication for posting updates to a social site -* -*/ +/** + * Copyright (c) 2010 Sasken Communication Technologies Ltd. + * All rights reserved. + * This component and the accompanying materials are made available + * under the terms of the "Eclipse Public License v1.0" + * which accompanies this distribution, and is available + * at the URL "http://www.eclipse.org/legal/epl-v10.html" + * + * Initial Contributors: + * Chandradeep Gandhi, Sasken Communication Technologies Ltd - Initial contribution + * + * Contributors: + * Manasij Roy, Nalina Hariharan + * + * Description: + * The SmfEvent class represents an event + * + */ #ifndef SMFPOSTPROVIDER_H #define SMFPOSTPROVIDER_H #include #include #include +#include +#include "smfglobal.h" #include "smfprovider.h" #include "smfcontact.h" +#include "smfplace.h" class SmfProvider; //base-class for service provider class SmfContact; //class for Contact in a social network @@ -31,132 +35,167 @@ /** - * Location info + * class for information (text, image and url) contained in post in social network + * This could be changed to contain html data + * + * For those service provider which supports only string format, @see supportedFormats() */ -typedef QtMobility::QGeoPositionInfo SmfLocationInfo ; -class SmfPost; //class for information (text, image and url) contained in post in social network -class SmfContactModel; -class SmfStatusData; +class SmfPost : public QTextDocument + { + Q_OBJECT + +public: + SmfPost ( QObject * parent = 0 ); + SmfPost ( const QString & text, QObject * parent = 0 ); + +private: + QString* id; + SmfProvider* provider; + }; + +/** + * Presence info of the user + */ +enum SmfAppearenceInfo + { + ENotSupported, + EOnline, + EOffline, + EBusy, + EDoNotDisturb, + EAppearOffline, + EOther + }; //Post lists typedef QList SmfPostList; + /** + * @ingroup smf_client_group * Interface to post scrap/tweet like info. * Note that branding information for the particular service implementation * is available from getProvider() API. See also: * SmfProvider::serviceName(), SmfProvider::serviceIcon(), SmfProvider::description() * - * All of the functionality described here should be implemented by a service - * specific plug-in object. * Interface name for SmfPostProvider is org.symbian.smf.client.contact.posts */ class SMFCLIENT_EXPORT SmfPostProvider : public QObject -{ - Q_OBJECT + { + Q_OBJECT + +public: + /** + * Constructs SmfPostProvider. + * @param baseProvider The base provider info + * Seeing as this is a plug-in implementation, these will realistically + * be generated by SMF factory of some kind + */ + SmfPostProvider(SmfProvider* baseProvider); + ~SmfPostProvider(); + public: - /** - * Constructs SmfPostProvider. - * @param baseProvider The base provider info - * Seeing as this is a plug-in implementation, these will realistically - * be generated by SMF factory of some kind - */ - SmfPostProvider(SmfProvider* baseProvider = 0); - ~SmfPostProvider(); + /** + * returns maximum no of chars (unicode) that service provider can post without truncation + * negative value means no limit + */ + qint32 maxCharsInPost() const; + /** + * returns maximum no of items that can be returned in a single query to getPosts + * negative value means feature not supported. + */ + qint32 maxItems() const; - /** - * Presence info of the user - */ -enum SmfPresenceInfo - { - ENotSupported, - EOnline, - EOffline, - EBusy, - EDoNotDisturb, - EAppearOffline, - EOther - }; - -public: - /** - * Gets the posts asynchronously. The signal postsAvailable()with SmfPostList is emitted - * once the post lists are available - * @see postsAvailable() - */ - virtual void getPosts(SmfStatusData statusData) = 0; - - /** - * Gets the model - */ - virtual SmfContactModel model() = 0; + /** + * returns all the formatting of posts that this service provider supports. + * May return 0 items to mean only QString is supported. + */ + QVector supportedFormats () const; + + /** + * returns whether this SP supports Appearence @see SmfAppearenceInfo + */ + bool supportsAppearence () const; public slots: - /** - * Updates a post, the success of the post can be checked with signal + * Gets the posts asynchronously. The signal postsAvailable()with SmfPostList is emitted + * once the post lists are available + * @param user user's contact in this SP, omit for self contact + * @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query. + * @param perPage Item per page, default is SMF_ITEMS_PER_PAGE + * @see postsAvailable() + */ + void posts(SmfContact* user = 0,int pageNum=SMF_FIRST_PAGE,int perPage=SMF_ITEMS_PER_PAGE); + + /** + * Updates a post to own area, the success of the post can be checked with signal * updatePostFinished() signal * @param postData data to be posted * @param location location data */ - virtual void updatePost(SmfPost& postData,SmfLocationInfo& location) = 0; // list of contact objects + void post(SmfPost& postData,SmfPlace& location) ; /** - * Updates a post, the success of the post can be checked with signal + * Updates the last post to own area with new data, the success of the post can be checked with signal * updatePostFinished() signal - * @param postData data to be posted + * @param postData edited/new data to be posted * @param location location data */ - virtual void updatePost(SmfPost& postData) = 0; // list of contact objects - - /** - * Updates a post to a particular Smf contact. the success of the post can be checked with signal - * updatePostFinished() signal. - * @param postData data to be posted - * @param contact contact to which the post is to be directed - * @param location location data - */ - virtual void updatePostDirected(SmfPost& postData,SmfContact& contact,SmfLocationInfo location) = 0; // list of contact objects - - /** - * Posts appearance info of the user. - * @param appearence user appearance - * @see SmfPresenceInfo - */ - virtual QList postAppearence(SmfPresenceInfo appearence) = 0; // appear offline, busy, do-not-disturb - - //APIs to get/set base provider info (SmfProvider) - - /** - * Gets the base provider info - */ - virtual SmfProvider* getProvider() = 0; - - /** - * Sets the base provider info - */ - virtual void setProvider(SmfProvider* provider) = 0; - - Q_SIGNALS: - + void updatePost(SmfPost& postData); + + /** + * Updates a post to a particular Smf contact. the success of the post can be checked with signal + * updatePostFinished() signal. + * @param postData data to be posted + * @param contact contact to which the post is to be directed + * @param location location data + */ + void postDirected(SmfPost& postData,SmfContact& contact,SmfPlace* location=0); + + /** + * Posts appearance info of the user.e.g. appear offline, busy, do-not-disturb + * @param appearence user appearance + * @see SmfPresenceInfo + * @return False on Failure/Not supported + */ + bool postAppearence(SmfAppearenceInfo appearence); + /** + * Share /a contact's post to user's friends and followers (e.g. retweet in twitter, share on facebook) + * emits updatePostFinished() signal when done. + * @param postData data to be posted + * @param contact contact to which the post belonged + * @param bool whether user changed items within the post + */ + void sharePost(SmfPost& postData,SmfContact& contact,bool edited); + + //APIs to get/set base provider info (SmfProvider) + + /** + * Gets the base provider info + */ + SmfProvider* getProvider() const; + +signals: + /** * Emitted when a request to getPosts() is finished * Note if number of posts is large, then it can download the list page by page * In that case this signal is emitted multiple times. * @param list list of posts * @param error error string - * @param pageNumber Page number + * @param resultPage Page number info */ - void postsAvailable(SmfPostList* list, QString error, int pageNumber=0); + void postsAvailable(SmfPostList* list, QString error, SmfResultPage resultPage); /** * Emitted when update post is finished. * @param success the success of the update */ - void updatePostFinished(bool success); + void postFinished(bool success); + + private: + SmfProvider* m_baseProvider; + }; -private: - SmfProvider* m_baseProvider; -}; - -SMF_GETSERVICES(SmfPostProvider, "org.symbian.smf.client.contact.posts\0.2") +SMF_SERVICE_NAME(SmfPostProvider, "org.symbian.smf.client.contact.posts\0.2") #endif // SMFPOSTPROVIDER_H