2 // Open Service Platform
3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
5 // Licensed under the Apache License, Version 2.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
9 // http://www.apache.org/licenses/LICENSE-2.0
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
18 * @file FCntOtherContentInfo.h
19 * @brief This is the header file for the %OtherContentInfo class.
21 * This header file contains the declarations of the %OtherContentInfo class.
24 #ifndef _FCNT_OTHER_CONTENT_INFO_H_
25 #define _FCNT_OTHER_CONTENT_INFO_H_
27 #include <FCntContentInfo.h>
29 namespace Tizen { namespace Content
32 class _OtherContentInfoImpl;
35 * @class OtherContentInfo
36 * @brief This class provides methods to access the other content information.
40 * @final This class is not intended for extension.
42 * The %OtherContentInfo class provides methods to access the other content information. @n
43 * Before getting the other content information, the ContentManager class must be used to create the content. @n
44 * If the E_UNSUPPORTED_FORMAT exception is received from the ContentManagerUtil::CheckContentType() method, the file can only be created as %OtherContentInfo.
46 * For more information on the different types of content information, see <a href="../org.tizen.native.appprogramming/html/guide/content/device_content_mgmt.htm">Device Content Management</a>.
48 * The following example demonstrates how to use the %OtherContentInfo class.
52 * MyClass::TestOtherContentInfo(void)
54 * result r = E_SUCCESS;
56 * ContentId contentId;
57 * ContentManager contentManager;
58 * r = contentManager.Construct();
59 * TryReturn(!IsFailed(r), r, "Construct failed.");
61 * OtherContentInfo otherContentInfo;
62 * r = otherContentInfo.Construct(null);
63 * TryReturn(!IsFailed(r), r, "Construct failed.");
65 * Tizen::Base::String sourcePath = Tizen::App::App::GetInstance()->GetAppRootPath() + L"data/flower.doc";
66 * Tizen::Base::String destPath = Tizen::System::Environment::GetMediaPath() + L"Others/flower.doc";
68 * contentId = contentManager.CreateContent(sourcePath, destPath, false, &otherContentInfo);
69 * TryReturn(Tizen::Base::UuId::GetInvalidUuId() != contentId, GetLastResult(), "CreateContent failed.");
75 class _OSP_EXPORT_ OtherContentInfo
76 : public Tizen::Content::ContentInfo
80 * The object is not fully constructed after this constructor is called. @n
81 * For full construction, the Construct() method must be called right after calling this constructor.
85 OtherContentInfo(void);
88 * This destructor overrides Tizen::Base::Object::~Object().
92 virtual ~OtherContentInfo(void);
95 * Initializes this instance of %OtherContentInfo with the specified parameter.
98 * @brief <i> [Compatibility] </i>
102 * @compatibility This method has compatibility issues with OSP compatible applications. @n
103 * For more information, see @ref CompOtherContentInfoConstructPage "here".
106 * @return An error code
107 * @param[in] pContentPath The content path
108 * @exception E_SUCCESS The method is successful.
109 * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
110 * @exception E_INVALID_ARG The specified input parameter is invalid.
111 * @exception E_OUT_OF_MEMORY The memory is insufficient.
112 * @exception E_IO An I/O error has occurred.
113 * @exception E_SYSTEM An internal error has occurred.
114 * @remarks The @c pContentPath should start with directory path returned by either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). @n
115 * If @c pContentPath is @c null, use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n
116 * or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*).
118 result Construct(const Tizen::Base::String* pContentPath);
122 * @page CompOtherContentInfoConstructPage Compatibility for the file path.
123 * @section CompOtherContentInfoConstructPageIssueSection Issues
124 * The content path argument of this method in OSP compatible applications has the following issues: @n
125 * -# The content path should be a path that begins with an allowed path prefix. @n
126 * For example, L"/Media/Images/flower.jpg", L"/Storagecard/Media/Images/flower.jpg".
128 * @section CompOtherContentInfoConstructPageSolutionSection Resolutions
129 * This issue has been resolved in Tizen. @n
130 * -# The content path can be a path without a specific allowed path prefix. @n
131 * Application do not need to know the specific allowed path prefixes. @n
132 * To get the directory path, use the following methods: @n
133 * - For accessing the media directory, use Tizen::System::Environment::GetMediaPath().
134 * - For accessing the external storage, use Tizen::System::Environment::GetExternalStoragePath().
140 * Initializes this instance of %OtherContentInfo with the specified parameters.
142 * @brief <i> [Deprecated] </i>
143 * @deprecated This method is deprecated as there is a problem in managing the user-defined thumbnail and device coordinates. @n
144 * Instead of using this method, use Construct(const Tizen::Base::String*). @n
145 * To set the coordinates in the ContentInfo instance, use ContentInfo::SetCoordinates(const Tizen::Locations::Coordinates&).
148 * @return An error code
149 * @param[in] contentPath The content path
150 * @param[in] thumbnailPath The thumbnail path
151 * @param[in] setGps Set to @c true to save the device's last known coordinates in the ContentInfo instance, @n
153 * The coordinate information may be incorrect if it is outdated or has never been updated. @n
154 * To update the coordinate information or to get the exact value,
155 * use Tizen::Locations::LocationProvider::RequestLocationUpdates() before calling this method.
156 * @exception E_SUCCESS The method is successful.
157 * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
158 * @exception E_INVALID_ARG The specified input parameter is invalid.
159 * @exception E_OUT_OF_MEMORY The memory is insufficient.
160 * @exception E_IO An I/O error has occurred.
162 * - The content path must start with @c '/Media' or @c '/Storagecard/Media'.
163 * - The thumbnail path must start with @c '/Home', @c '/Media', or @c '/Storagecard/Media'. @n
164 * The permitted format for a thumbnail image is bitmap (bmp).
167 virtual result Construct(const Tizen::Base::String& contentPath, const Tizen::Base::String& thumbnailPath = L"", bool setGps = false);
171 * The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
173 OtherContentInfo(const OtherContentInfo& rhs);
176 * The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
178 OtherContentInfo& operator =(const OtherContentInfo& rhs);
183 friend class _OtherContentInfoImpl;
184 _OtherContentInfoImpl* __pImpl;
186 }; // class OtherContentInfo
190 #endif // _FCNT_OTHER_CONTENT_INFO_H_