Skip to content

Commit bd6e1d3

Browse files
authored
Merge pull request #511 from rdkcentral/topic/RDKEMW-7761
RDKEMW-7761 Move Telemetry related APIs to the Telemetry plugin
2 parents a2826f0 + e5132f8 commit bd6e1d3

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

apis/Telemetry/ITelemetry.h

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,10 @@ namespace WPEFramework
3131
{
3232
enum { ID = ID_TELEMETRY };
3333

34+
struct EXTERNAL TelemetrySuccess {
35+
bool success;
36+
};
37+
3438
// @event
3539
struct EXTERNAL INotification : virtual public Core::IUnknown
3640
{
@@ -42,22 +46,22 @@ namespace WPEFramework
4246
virtual void OnReportUpload(const string& telemetryUploadStatus) {};
4347
};
4448

45-
virtual Core::hresult Register(ITelemetry::INotification* notification /* @in */) = 0;
46-
virtual Core::hresult Unregister(ITelemetry::INotification* notification /* @in */) = 0;
49+
virtual Core::hresult Register(ITelemetry::INotification* notification) = 0;
50+
virtual Core::hresult Unregister(ITelemetry::INotification* notification) = 0;
4751

4852
/**********************setReportProfileStatus() - start****************************/
4953
// @text setReportProfileStatus
5054
// @brief Sets the status of telemetry reporting
5155
// @param status - in - string
52-
virtual Core::hresult SetReportProfileStatus(const string& status /* @in */) = 0;
56+
virtual Core::hresult SetReportProfileStatus(const string& status) = 0;
5357
/**********************setReportProfileStatus() - end******************************/
5458

5559
/**********************logApplicationEvent() - start*******************************/
5660
// @text logApplicationEvent
5761
// @brief Logs an application
5862
// @param eventName - in - string
5963
// @param eventValue - in - string
60-
virtual Core::hresult LogApplicationEvent(const string& eventName /* @in */, const string& eventValue /* @in */) = 0;
64+
virtual Core::hresult LogApplicationEvent(const string& eventName , const string& eventValue) = 0;
6165
/**********************logApplicationEvent() - end*********************************/
6266

6367
/**********************uploadReport() - start**************************************/
@@ -71,6 +75,22 @@ namespace WPEFramework
7175
// @brief Abort report upload
7276
virtual Core::hresult AbortReport() = 0;
7377
/**********************abortReport() - end*****************************************/
78+
79+
/**********************setOptOutTelemetry() - start***************************************/
80+
// @text setOptOutTelemetry
81+
// @brief Sets the telemetry opt-out status.
82+
// @param OptOut - in - boolean
83+
// @param - out - struct
84+
virtual Core::hresult SetOptOutTelemetry(const bool optOut /* @text Opt-Out */, TelemetrySuccess& successResult /* @out */) = 0;
85+
/**********************setOptOutTelemetry() - end*****************************************/
86+
87+
/**********************isOptOutTelemetry() - start***************************************/
88+
// @text isOptOutTelemetry
89+
// @brief Checks the telemetry opt-out status.
90+
// @param OptOut - out - boolean
91+
// @param success - out - boolean
92+
virtual Core::hresult IsOptOutTelemetry(bool& optOut /* @out @text Opt-Out*/, bool& success /* @out */) = 0;
93+
/**********************isOptOutTelemetry() - end*****************************************/
7494
};
7595
} // namespace Exchange
7696
} // namespace WPEFramework

0 commit comments

Comments
 (0)