QueryArgs Struct Reference

#include <abstractstorage.h>

Public Attributes
int	bodyLimit = -1
IdList	inIds
FuotenEnums::Type	inIdsType = FuotenEnums::All
int	limit = 0
qint64	parentId = -1
FuotenEnums::Type	parentIdType = FuotenEnums::All
bool	queuedOnly = false
FuotenEnums::SortingRole	sortingRole = FuotenEnums::ID
Qt::SortOrder	sortOrder = Qt::AscendingOrder
bool	starredOnly = false
bool	unreadOnly = false

Detailed Description

Helper struct containing query arguments.

Used by AbstractStrorage::getFolders(), AbstractStroage::getFeeds() and AbstractStorage::getArticles() to set the arguments used to query a list of objects. Not all members of this struct are used by every query.

Member Data Documentation

bodyLimit

int bodyLimit = -1

Only valid for article queries. Limits the size of the body text in number of characters. Values lower than 0 will return no body text, 0 will return the full body text, any other positive value will return a body stripped from HTML tags and limited to the amount of characters.

inIds

IdList inIds

A list of IDs the records are compared with. Defaults to an empty list.

inIdsType

FuotenEnums::Type inIdsType = FuotenEnums::All

Type of of the inIds list to compare. Related to the object to query, it can be FuotenEnums::Folder, FuotenEnums::Feed or FuotenEnums::Item. Defaults to FuotenEnums::All.

limit

int limit = 0

Limits the result to the specified number of objects. Defaults to 0 to return all objects.

parentId

qint64 parentId = -1

ID of a parent object (Feed or Folder). Used by feed and article queries, defaults to -1.

parentIdType

FuotenEnums::Type parentIdType = FuotenEnums::All

Only usable on articles where it can can be FuotenEnums::Folder or FuotenEnums::Feed. Defaults to FuotenEnums::All

queuedOnly

bool queuedOnly = false

Only valid for article queries. Will only return items/articles that are queued.

sortingRole

FuotenEnums::SortingRole sortingRole = FuotenEnums::ID

The role/value used to sort the result by.

sortOrder

Qt::SortOrder sortOrder = Qt::AscendingOrder

The sorting order.

starredOnly

bool starredOnly = false

Only valid for article queries. If true, only starrred articles are returned.

unreadOnly

bool unreadOnly = false

If true, only unread articles or folders and feeds without unread content are returned.