diff options
Diffstat (limited to 'lib/csapi/voip.h')
| -rw-r--r-- | lib/csapi/voip.h | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/lib/csapi/voip.h b/lib/csapi/voip.h index fafbaf4a..ca190df7 100644 --- a/lib/csapi/voip.h +++ b/lib/csapi/voip.h @@ -12,14 +12,19 @@ namespace QMatrixClient { // Operations + /// Obtain TURN server credentials. + /// + /// This API provides credentials for the client to use when initiating + /// calls. class GetTurnServerJob : public BaseJob { public: explicit GetTurnServerJob(); - /** Construct a URL out of baseUrl and usual parameters passed to - * GetTurnServerJob. This function can be used when - * a URL for GetTurnServerJob is necessary but the job + /*! Construct a URL without creating a full-fledged job object + * + * This function can be used when a URL for + * GetTurnServerJob is necessary but the job * itself isn't. */ static QUrl makeRequestUrl(QUrl baseUrl); @@ -28,6 +33,7 @@ namespace QMatrixClient // Result properties + /// The TURN server credentials. const QJsonObject& data() const; protected: |