Skip to content

Commit f88e62c

Browse files
ssitar583ssitar583
authored
Update IXCast.h
1 parent 7fa00d0 commit f88e62c

File tree

1 file changed

+12
-20
lines changed

1 file changed

+12
-20
lines changed

‎apis/XCast/IXCast.h‎

Lines changed: 12 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ namespace WPEFramework {
3434
RUNNING = 0 /* @text running */,
3535
STOPPED = 1/* @text stopped */,
3636
HIDDEN = 2 /* @text suspended */
37-
};
37+
};
3838

3939
enum StandbyBehavior : uint8_t {
4040
ACTIVE = 0 /* @text active */,
@@ -51,9 +51,9 @@ namespace WPEFramework {
5151

5252

5353
struct EXTERNAL ApplicationInfo {
54-
string appName /* @text names */ /* @brief Group of acceptable names for a related application. Application name in request URI must have exact match to one of the names. Otherwise, matching prefix is needed. If the application name in request URI does not match any names or prefixes, then the request shall fail */;
55-
string prefixes /* @text prefixes */ /* @brief If the application name in request URI does not match the list of names, it must contain one of the prefixes.If the application name in request URI does not match any names or prefixes, then the request shall fail */;
56-
string cors /* @text cors */ /* @brief a set of origins allowed for the application. This must not be empty */;
54+
string appName /* @text name */ /* @brief Application name in request URI must have exact match to one of the names. Otherwise, matching prefix is needed. If the application name in request URI does not match any names or prefixes, then the request shall fail */;
55+
string prefixes /* @text prefix */ /* @brief If the application name in request URI does not match the appname given here, it must contain some prefix.If the application name in request URI does not match the appnames or prefix, then the request shall fail */;
56+
string cors /* @text cors */ /* @brief origin allowed for the application. This must not be empty */;
5757
string query /* @text query */ /* @brief query string that need to be appended in launch request */;
5858
string payload /* @text payload */ /* @brief optional payload string that need to be appended in launch request */;
5959
int allowStop /* @text allowStop */ /* @brief is the application (matching name list or prefix list) allowed to stop (no PID presence) after launched */;
@@ -72,12 +72,12 @@ namespace WPEFramework {
7272
// @param strPayLoad: Payload string to be passed to the application
7373
// @param strQuery: Query string to be appended in launch request
7474
// @param strAddDataUrl: Additional data URL to be passed to the application
75-
virtual void OnApplicationLaunchRequestWithLaunchParam(const string& appName /* @text applicationName */ , const string& strPayLoad /* @text strPayLoad */, const string& strQuery /* @text strQuery */, const string& strAddDataUrl /* @text strAddDataUrl */) {};
75+
virtual void OnApplicationLaunchRequestWithParam(const string& appName /* @text applicationName */ , const string& strPayLoad /* @text strPayLoad */, const string& strQuery /* @text strQuery */, const string& strAddDataUrl /* @text strAddDataUrl */) {};
7676
// @text onApplicationLaunchRequest
7777
// @brief Triggered when the cast service receives a launch request from a client with launch params
7878
// @param applicationName: Registered application name
7979
// @param parameter: Application launch string
80-
virtual void OnApplicationLaunchRequest(const string& appName /* @text applicationName */ , const string& parameter /* @text parameters */ ) {};
80+
virtual void OnApplicationLaunchRequest(const string& appName /* @text applicationName */ , const string& parameter /* @text parameter */ ) {};
8181
// @text onApplicationStopRequest
8282
// @brief Triggered when the cast service receives a stop request from a client
8383
// @param applicationName: Registered application name
@@ -88,11 +88,11 @@ namespace WPEFramework {
8888
// @param applicationName: Registered application name
8989
// @param applicationId: Application instance ID
9090
virtual void OnApplicationHideRequest(const string& appName /* @text applicationName */ , const string& appID /* @text applicationId */ ) {};
91-
// @text onApplicationStateRequest
91+
// @text onApplicationCurrentStateRequest
9292
// @brief Triggered when the cast service needs an update of the application state
9393
// @param applicationName: Registered application name
9494
// @param applicationId: Application instance ID
95-
virtual void OnApplicationStateRequest(const string& appName /* @text applicationName */ , const string& appID /* @text applicationId */ ) {};
95+
virtual void OnApplicationCurrentStateRequest(const string& appName /* @text applicationName */ , const string& appID /* @text applicationId */ ) {};
9696
// @text onApplicationResumeRequest
9797
// @brief Triggered when the cast service receives a resume request from a client
9898
// @param applicationName: Registered application name
@@ -103,15 +103,15 @@ namespace WPEFramework {
103103
virtual Core::hresult Register(IXCast::INotification* sink /* @in */) = 0;
104104
virtual Core::hresult Unregister(IXCast::INotification* sink /* @in */) = 0;
105105

106-
/****************************************applicationStateChanged()*****************************/
107-
// @text onApplicationStateChanged
106+
/****************************************UpdateApplicationState()*****************************/
107+
// @text updateApplicationState
108108
// @brief Triggered when the cast service receives an application state change notification from a client
109109
// @param applicationName: Registered application name
110110
// @param state: Application state
111111
// @param applicationId: Application instance ID
112112
// @param error: Error string, if any
113-
virtual Core::hresult ApplicationStateChanged(const string& applicationName /* @in @text applicationName */, const State& state /* @in @text state */, const string& applicationId /* @in @text applicationId */, const ErrorCode& error /* @in @text error */, bool& success /* @out */) = 0;
114-
/****************************************applicationStateChanged()*****************************/
113+
virtual Core::hresult UpdateApplicationState(const string& applicationName /* @in @text applicationName */, const State& state /* @in @text state */, const string& applicationId /* @in @text applicationId */, const ErrorCode& error /* @in @text error */, bool& success /* @out */) = 0;
114+
/****************************************UpdateApplicationState()*****************************/
115115

116116
/****************************************getProtocolVersion()**********************************/
117117
// @text getProtocolVersion
@@ -196,14 +196,6 @@ namespace WPEFramework {
196196
virtual Core::hresult GetFriendlyName(string &friendlyname /* @out @text friendlyname */, bool &success /* @out */) = 0;
197197
/***************************************** getFriendlyName() *********************************/
198198

199-
/****************************************getApiVersionNumber()**********************************/
200-
// @text getApiVersionNumber
201-
// @brief Gets the API version number
202-
// @param version: a version number
203-
// @param success: Whether the request succeeded
204-
virtual Core::hresult GetApiVersionNumber(uint32_t &version /* @out @text version */, bool &success/* @out */) = 0;
205-
/****************************************getApiVersionNumber()**********************************/
206-
207199
/****************************************registerApplications()**********************************/
208200
// @text registerApplications
209201
// @brief Registers an application

0 commit comments

Comments
 (0)