2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
4 // Licensed under the Apache License, Version 2.0 (the License);
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
8 // http://www.apache.org/licenses/LICENSE-2.0
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
17 * @file FAppIAppControlProviderEventListener.h
18 * @brief This is the header file for the %IAppControlProviderEventListener interface.
20 * This header file contains the declarations of the %IAppControlProviderEventListener interface.
23 #ifndef _FAPP_IAPPCONTROL_PROVIDER_EVENT_LISTENER_H_
24 #define _FAPP_IAPPCONTROL_PROVIDER_EVENT_LISTENER_H_
26 #include <FBaseObject.h>
27 #include <FBaseRtIEventListener.h>
28 #include <FAppTypes.h>
31 namespace Tizen { namespace Base { namespace Collection {
36 namespace Tizen { namespace App
40 * @interface IAppControlProviderEventListener
41 * @brief This interface defines the provider listener for the %AppControl request.
45 * The %IAppControlProviderEventListener interface defines a listener for the AppControl request events.
46 * Applications that provide the %AppControl functionality must implement this interface.
48 * @see AppControlProviderManager
50 class _OSP_EXPORT_ IAppControlProviderEventListener
51 : virtual public Tizen::Base::Runtime::IEventListener
55 * This polymorphic destructor should be overridden if required.
56 * This way, the destructors of the derived classes are called when the destructor of this interface is called.
60 virtual ~IAppControlProviderEventListener(void) {}
63 * Called when the application control request is received from the caller application. @n
64 * The application control provider must implement this listener for exporting its own functionality.
68 * @param[in] reqId The application control request ID
69 * @param[in] operationId The application control operation ID
70 * @param[in] pUriData A pointer to the URI data
71 * @param[in] pMimeType A pointer to the MIME type (RFC 2046) data
72 * @param[in] pExtraData A pointer to an argument map of key and value pair where the key is of type Tizen::Base::String and the value is of type %Tizen::Base::String or of type Tizen::Base::Collection::ArrayList of %Tizen::Base::String
73 * @remarks To reply to the application control request, use AppControlProviderManager::SendAppControlResult() with the given request ID.
74 * @remarks When the application receives the AppControl request on the background,
75 * %OnAppControlRequestReceived() is invoked before UiApp::OnForeground().
76 * @remarks When the application control is resolved with the file extension with AppControl::FindAndStart(),
77 * the delivered file extension is converted to the corresponding MIME type in the @c pMimeType parameter.
79 virtual void OnAppControlRequestReceived(RequestId reqId, const Tizen::Base::String& operationId, const Tizen::Base::String* pUriData, const Tizen::Base::String* pMimeType, const Tizen::Base::Collection::IMap* pExtraData) = 0;
83 // This method is for internal use only. Using this method can cause behavioral,
84 // security-related, and consistency-related issues in the application.
88 virtual void IAppControlProviderEventListener_Reserved1(void) {}
91 // This method is for internal use only. Using this method can cause behavioral,
92 // security-related, and consistency-related issues in the application.
96 virtual void IAppControlProviderEventListener_Reserved2(void) {}
99 // This method is for internal use only. Using this method can cause behavioral,
100 // security-related, and consistency-related issues in the application.
104 virtual void IAppControlProviderEventListener_Reserved3(void) {}
106 }; // IAppControlProviderEventListener
110 #endif // _FAPP_IAPPCONTROL_PROVIDER_EVENT_LISTENER_H_