Huggle  build:^490^dce1e5c
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
Huggle::ApiQuery Class Reference

This class can be used to execute any kind of api query on any wiki. More...

#include <apiquery.hpp>

+ Inheritance diagram for Huggle::ApiQuery:

Public Member Functions

 ApiQuery ()
 Creates a new instance of this class and set the defaults.
 
void Kill ()
 Terminate the query.
 
void Process ()
 Run.
 
QString QueryTargetToString ()
 Get a query target as a string.
 
QString QueryTypeToString ()
 Returns a type of query as a string.
 
void SetAction (const Action action)
 Change the action type.
 
void SetAction (const QString action)
 Set the raw action type, you should not use this unless you have to.
 
- Public Member Functions inherited from Huggle::Query
 Query ()
 Creates empty query.
 
virtual ~Query ()
 Destructor for query.
 
void ProcessCallback ()
 
virtual bool Processed ()
 Returns true in case that query is processed.
 
unsigned int QueryID ()
 
virtual QString QueryStatusToString ()
 
- Public Member Functions inherited from Huggle::Collectable
unsigned long CollectableID ()
 CollectableID. More...
 
QString DebugHgc ()
 DebugHgc. More...
 
bool IsLocked ()
 
bool IsManaged ()
 IsManaged Managed class is deleted by GC and must not be deleted by hand. More...
 
void Lock ()
 Lock this object so that other threads can't change consumers or modify its properties.
 
void RegisterConsumer (const int consumer)
 Registers a consumer. More...
 
void RegisterConsumer (const QString consumer)
 Registers a consumer. More...
 
virtual bool SafeDelete ()
 Use this if you are not sure if you can delete this object in this moment.
 
void Unlock ()
 Unlock this object for deletion by other threads.
 
void UnregisterConsumer (const int consumer)
 This function will remove a string which prevent the object from being removed. More...
 
void UnregisterConsumer (const QString consumer)
 This function will remove a string which prevent the object from being removed. More...
 

Public Attributes

QString OverrideWiki
 You can change this to url of different wiki than a project.
 
QString Parameters
 Parameters for action, for example page title.
 
Format RequestFormat
 This is a requested format in which the result should be written in.
 
QString Target
 This is optional property which contains a label of target this query is for.
 
QString URL
 
bool UsingPOST
 Whether the query will submit parameters using POST data.
 
- Public Attributes inherited from Huggle::Query
Callback callback
 Callback. More...
 
void * CallbackResult
 This is a pointer to object returned by your callback function.
 
QString CustomStatus
 Custom status. More...
 
QueryDependency
 Dependency for query. More...
 
bool HiddenQuery
 
QueryResultResult
 Result of query, see documentation of QueryResult for more.
 
bool RetryOnTimeoutFailure
 
QDateTime StartTime
 
enum _Status Status
 Current status of a query.
 
int Timeout
 
QueryType Type
 Type of a query. More...
 

Private Slots

void Finished ()
 
void ReadData ()
 

Private Member Functions

QString ConstructParameterLessUrl ()
 
void ConstructUrl ()
 Generate api url.
 
void FinishRollback ()
 This is only needed when you are using rollback.
 
bool FormatIsCurrentlySupported ()
 Check if return format is supported by huggle.
 

Private Attributes

QString ActionPart
 
QNetworkReply * reply
 Reply from qnet.
 

Additional Inherited Members

- Static Public Attributes inherited from Huggle::Query
static QNetworkAccessManager NetworkManager
 

Detailed Description

This class can be used to execute any kind of api query on any wiki.

Definition at line 55 of file apiquery.hpp.

Member Data Documentation

QString Huggle::ApiQuery::URL

This is an url of api request, you probably don't want to change it unless you want to construct whole api request yourself

Definition at line 82 of file apiquery.hpp.

Referenced by ApiQuery(), ConstructUrl(), and Process().


The documentation for this class was generated from the following files: