ApiEndpoint Class Reference

Access to a LibrePCB API endpoint. More...

#include <apiendpoint.h>

Inherits QObject.

Collaboration diagram for ApiEndpoint:

Classes
struct	Library
struct	Part

Signals
void	libraryListReceived (QList< Library > libs)
void	errorWhileFetchingLibraryList (const QString &errorMsg)
void	errorWhileFetchingPartsInformationStatus (const QString &errorMsg)
void	partsInformationStatusReceived (const QJsonObject &status)
void	partsInformationReceived (const QJsonObject &info)
void	errorWhileFetchingPartsInformation (const QString &errorMsg)

Public Member Functions
	ApiEndpoint ()=delete
	ApiEndpoint (const ApiEndpoint &other)=delete
	ApiEndpoint (const QUrl &url) noexcept
	~ApiEndpoint () noexcept
const QUrl &	getUrl () const noexcept
void	requestLibraryList () const noexcept
void	requestPartsInformationStatus () const noexcept
void	requestPartsInformation (const QUrl &url, const QVector< Part > &parts) const noexcept
ApiEndpoint &	operator= (const ApiEndpoint &rhs)=delete

Private Member Functions
void	requestLibraryList (const QUrl &url) const noexcept
void	libraryListResponseReceived (const QByteArray &data) noexcept
void	partsInformationStatusResponseReceived (const QByteArray &data) noexcept
void	partsInformationResponseReceived (const QByteArray &data) noexcept

Private Attributes
QUrl	mUrl

Detailed Description

Access to a LibrePCB API endpoint.

See also

Server API Specification

Constructor & Destructor Documentation

ApiEndpoint() [1/3]

ApiEndpoint ( )

delete

ApiEndpoint() [2/3]

ApiEndpoint ( const ApiEndpoint &  other )

delete

ApiEndpoint() [3/3]

ApiEndpoint ( const QUrl &  url )

explicitnoexcept

~ApiEndpoint()

~ApiEndpoint ( )

noexcept

Member Function Documentation

getUrl()

const QUrl & getUrl ( ) const

inlinenoexcept

Here is the caller graph for this function:

requestLibraryList() [1/2]

void requestLibraryList ( ) const

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

requestPartsInformationStatus()

void requestPartsInformationStatus ( ) const

noexcept

Here is the call graph for this function:

requestPartsInformation()

void requestPartsInformation ( const QUrl &  url, const QVector< Part > &  parts  ) const

noexcept

Here is the call graph for this function:

operator=()

ApiEndpoint & operator= ( const ApiEndpoint &  rhs )

delete

libraryListReceived

void libraryListReceived ( QList< Library >  libs )

signal

errorWhileFetchingLibraryList

void errorWhileFetchingLibraryList ( const QString &  errorMsg )

signal

Here is the caller graph for this function:

errorWhileFetchingPartsInformationStatus

void errorWhileFetchingPartsInformationStatus ( const QString &  errorMsg )

signal

Here is the caller graph for this function:

partsInformationStatusReceived

void partsInformationStatusReceived ( const QJsonObject &  status )

signal

Here is the caller graph for this function:

partsInformationReceived

void partsInformationReceived ( const QJsonObject &  info )

signal

Here is the caller graph for this function:

errorWhileFetchingPartsInformation

void errorWhileFetchingPartsInformation ( const QString &  errorMsg )

signal

Here is the caller graph for this function:

requestLibraryList() [2/2]

void requestLibraryList ( const QUrl &  url ) const

privatenoexcept

Here is the call graph for this function:

libraryListResponseReceived()

void libraryListResponseReceived ( const QByteArray &  data )

privatenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

partsInformationStatusResponseReceived()

void partsInformationStatusResponseReceived ( const QByteArray &  data )

privatenoexcept

Here is the caller graph for this function:

partsInformationResponseReceived()

void partsInformationResponseReceived ( const QByteArray &  data )

privatenoexcept

Here is the caller graph for this function:

Member Data Documentation

mUrl

QUrl mUrl

private

---

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

• /__w/1/s/libs/librepcb/core/network/apiendpoint.h
• /__w/1/s/libs/librepcb/core/network/apiendpoint.cpp