• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdepimlibs API Reference
  • KDE Home
  • Contact Us
 

Akonadi Social Utils Library

  • Akonadi
  • SocialFeedItem
Public Member Functions | List of all members
Akonadi::SocialFeedItem Class Reference

#include <socialfeeditem.h>

Public Member Functions

 SocialFeedItem (const SocialFeedItem &other)
 
QUrl avatarUrl () const
 
bool isLiked () const
 
bool isShared () const
 
QVariantMap itemSourceMap () const
 
QString networkString () const
 
SocialFeedItem & operator= (const SocialFeedItem &other)
 
QString postId () const
 
QUrl postImageUrl () const
 
QString postInfo () const
 
QUrl postLink () const
 
QString postLinkTitle () const
 
QList< SocialFeedItem > postReplies () const
 
QString postText () const
 
KDateTime postTime () const
 
QString postTimeFormat () const
 
QString postTimeString () const
 
void setAvatarUrl (const QUrl &url)
 
void setItemSourceMap (const QVariantMap &itemSourceMap)
 
void setLiked (bool liked)
 
void setNetworkString (const QString &networkString)
 
void setPostId (const QString &postId)
 
void setPostImageUrl (const QUrl &imageUrl)
 
void setPostInfo (const QString &postInfo)
 
void setPostLink (const QUrl &link)
 
void setPostLinkTitle (const QString &linkTitle)
 
void setPostReplies (const QList< SocialFeedItem > &replies)
 
void setPostText (const QString &text)
 
void setPostTime (const QString &postTimeString, const QString &postTimeFormat)
 
void setShared (bool shared)
 
void setSharedFrom (const QString &sharedFrom)
 
void setSharedFromId (const QString &sharedFromId)
 
void setUserDisplayName (const QString &userDisplayName)
 
void setUserId (const QString &userId)
 
void setUserName (const QString &userName)
 
QString sharedFrom () const
 
QString sharedFromId () const
 
QString userDisplayName () const
 
QString userId () const
 
QString userName () const
 

Detailed Description

Class representing one entry in the social feed.

Definition at line 38 of file socialfeeditem.h.

Member Function Documentation

QUrl Akonadi::SocialFeedItem::avatarUrl ( ) const
Returns
Url of the avatar picture

Definition at line 213 of file socialfeeditem.cpp.

bool Akonadi::SocialFeedItem::isLiked ( ) const
Returns
True if the post was liked/favorited by the signed-in user, false otherwise

Definition at line 223 of file socialfeeditem.cpp.

bool Akonadi::SocialFeedItem::isShared ( ) const
Returns
True if this post was shared from other user

Definition at line 173 of file socialfeeditem.cpp.

QVariantMap Akonadi::SocialFeedItem::itemSourceMap ( ) const
Returns
The whole original data as received from the network mapped in QVariantMap

Definition at line 203 of file socialfeeditem.cpp.

QString Akonadi::SocialFeedItem::networkString ( ) const

This returns the service string such as "on Facebook", "on Twitter" It's used in the feed as the first line of the item eg.

"Marty on Twitter:"

Returns
Network string

Definition at line 50 of file socialfeeditem.cpp.

QString Akonadi::SocialFeedItem::postId ( ) const
Returns
Original post id (eg. Facebook post id, Twitter post id etc).

Definition at line 60 of file socialfeeditem.cpp.

QUrl Akonadi::SocialFeedItem::postImageUrl ( ) const
Returns
URL of an image associated with this post

Definition at line 100 of file socialfeeditem.cpp.

QString Akonadi::SocialFeedItem::postInfo ( ) const
Returns
Additional info for the post, like number of comments, likes, retweed from etc

Definition at line 120 of file socialfeeditem.cpp.

QUrl Akonadi::SocialFeedItem::postLink ( ) const
Returns
Link from the post

Definition at line 80 of file socialfeeditem.cpp.

QString Akonadi::SocialFeedItem::postLinkTitle ( ) const
Returns
Link title from the post

Definition at line 90 of file socialfeeditem.cpp.

QList< Akonadi::SocialFeedItem > Akonadi::SocialFeedItem::postReplies ( ) const
Returns
List of replies/comments to this post

Definition at line 233 of file socialfeeditem.cpp.

QString Akonadi::SocialFeedItem::postText ( ) const
Returns
The text of the post that is displayed in the feed

Definition at line 70 of file socialfeeditem.cpp.

KDateTime Akonadi::SocialFeedItem::postTime ( ) const
Returns
Time of the post

Definition at line 110 of file socialfeeditem.cpp.

QString Akonadi::SocialFeedItem::postTimeFormat ( ) const
Returns
The time format of the time string for this post

Definition at line 138 of file socialfeeditem.cpp.

QString Akonadi::SocialFeedItem::postTimeString ( ) const
Returns
The original time string as received from the network

Definition at line 115 of file socialfeeditem.cpp.

void Akonadi::SocialFeedItem::setAvatarUrl ( const QUrl &  url)

Sets the url of the avatar picture to be displayed next to the post in the feed.

Parameters
urlAvatar url

Definition at line 218 of file socialfeeditem.cpp.

void Akonadi::SocialFeedItem::setItemSourceMap ( const QVariantMap &  itemSourceMap)

Sets the original data which was received from the network and then mapped to a QVariantMap.

This allows the full original data to be serialized along with the social feed item and reused later for whatever purpose

Parameters
itemSourceMapThe original data in a QVariantMap

Definition at line 208 of file socialfeeditem.cpp.

void Akonadi::SocialFeedItem::setLiked ( bool  liked)

Sets if the user has liked/favorited the post or not.

Parameters
likedTrue if the post was liked/favorited, false otherwise

Definition at line 228 of file socialfeeditem.cpp.

void Akonadi::SocialFeedItem::setNetworkString ( const QString &  networkString)

Sets the network string for this item.

Parameters
networkStringThe network string

Definition at line 55 of file socialfeeditem.cpp.

void Akonadi::SocialFeedItem::setPostId ( const QString &  postId)

Sets the original post id.

Parameters
postIdPost id from the network (eg. Facebook post id, Twitter post id etc).

Definition at line 65 of file socialfeeditem.cpp.

void Akonadi::SocialFeedItem::setPostImageUrl ( const QUrl &  imageUrl)

Sets the URL of an image associated with this post, it can be an image thumb, link thumb etc.

Parameters
imageUrlThe URL of the image

Definition at line 105 of file socialfeeditem.cpp.

void Akonadi::SocialFeedItem::setPostInfo ( const QString &  postInfo)

Sets additional info for the post, like number of comments, likes, retweed from etc.

For now all just in one string

Parameters
postInfoThe string with the info

Definition at line 125 of file socialfeeditem.cpp.

void Akonadi::SocialFeedItem::setPostLink ( const QUrl &  link)

Sets the link the posts links to.

Parameters
linkURL of the link

Definition at line 85 of file socialfeeditem.cpp.

void Akonadi::SocialFeedItem::setPostLinkTitle ( const QString &  linkTitle)

Sets the link title the posts links to.

Parameters
linkTitleTitle of the link

Definition at line 95 of file socialfeeditem.cpp.

void Akonadi::SocialFeedItem::setPostReplies ( const QList< SocialFeedItem > &  replies)

Sets replies/comments for this post.

Parameters
repliesList of replies

Definition at line 238 of file socialfeeditem.cpp.

void Akonadi::SocialFeedItem::setPostText ( const QString &  text)

Sets the post text to be displayed in the feed.

Parameters
textThe post text in the feed

Definition at line 75 of file socialfeeditem.cpp.

void Akonadi::SocialFeedItem::setPostTime ( const QString &  postTimeString,
const QString &  postTimeFormat 
)

Sets the time string which was received from the network together with the format which could be received from the network as well or custom-supplied.

Parameters
postTimeStringThe time string
postTimeFormatThe time format of the string

Definition at line 130 of file socialfeeditem.cpp.

void Akonadi::SocialFeedItem::setShared ( bool  shared)

Sets if this post was shared from other user.

Parameters
sharedTrue if shared, false if not

Definition at line 178 of file socialfeeditem.cpp.

void Akonadi::SocialFeedItem::setSharedFrom ( const QString &  sharedFrom)

Sets the display name of the user which was the original author of this post.

Parameters
sharedFromUser which was this post shared from

Definition at line 188 of file socialfeeditem.cpp.

void Akonadi::SocialFeedItem::setSharedFromId ( const QString &  sharedFromId)

Sets the user id of the user this was shared from.

Parameters
sharedFromIdUser id of the original author

Definition at line 198 of file socialfeeditem.cpp.

void Akonadi::SocialFeedItem::setUserDisplayName ( const QString &  userDisplayName)

Sets the name to be displayed to the user (full name usually)

Parameters
userDisplayNameDisplay name

Definition at line 168 of file socialfeeditem.cpp.

void Akonadi::SocialFeedItem::setUserId ( const QString &  userId)

Sets the network user id associated with this post.

Parameters
userIdNetwork user id

Definition at line 148 of file socialfeeditem.cpp.

void Akonadi::SocialFeedItem::setUserName ( const QString &  userName)

Sets the network user name associated with this post.

Parameters
userNameNetwork user name

Definition at line 158 of file socialfeeditem.cpp.

QString Akonadi::SocialFeedItem::sharedFrom ( ) const
Returns
Display name of the user which was this post shared from

Definition at line 183 of file socialfeeditem.cpp.

QString Akonadi::SocialFeedItem::sharedFromId ( ) const
Returns
User id of the user this was shared from

Definition at line 193 of file socialfeeditem.cpp.

QString Akonadi::SocialFeedItem::userDisplayName ( ) const
Returns
Name that is displayed to the user

Definition at line 163 of file socialfeeditem.cpp.

QString Akonadi::SocialFeedItem::userId ( ) const
Returns
Network user id

Definition at line 143 of file socialfeeditem.cpp.

QString Akonadi::SocialFeedItem::userName ( ) const
Returns
Post user name

Definition at line 153 of file socialfeeditem.cpp.


The documentation for this class was generated from the following files:
  • socialfeeditem.h
  • socialfeeditem.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:00:56 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Akonadi Social Utils Library

Skip menu "Akonadi Social Utils Library"
  • Main Page
  • Alphabetical List
  • Class List
  • Class Members
  • File List
  • Related Pages

kdepimlibs API Reference

Skip menu "kdepimlibs API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kldap
  • kmbox
  • kmime
  • kpimidentities
  • kpimtextedit
  • kresources
  • ktnef
  • kxmlrpcclient
  • microblog

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal