History

changes per CR feedback; additional jsdoc

humbletim committed 8 years ago

Commit c2ee1391 parent 76cbc4e3 files · +18 −7Browse files

Showing the changes to libraries/script-engine/src/AssetScriptingInterface.cpp (1 of 3 files). Show all

Unified · Split

libraries/script-engine/src/AssetScriptingInterface.cpp+17−3
@@ -215,6 +215,21 @@ void AssetScriptingInterface::deleteAsset(QScriptValue options, QScriptValue sco · 214 unmodified lines
215215 jsVerify(false, "TODO: deleteAsset API");
216216 }
217217
218+/**jsdoc
219+ * @typedef {string} Assets.GetOptions.ResponseType
220+ * <p>Available <code>responseType</code> values for use with @{link Assets.getAsset} and @{link Assets.loadFromCache} configuration option. </p>
221+ * <table>
222+ * <thead>
223+ * <tr><th>responseType</th><th>typeof response value</th></tr>
224+ * </thead>
225+ * <tbody>
226+ * <tr><td><code>"text"</code></td><td>contents returned as utf-8 decoded <code>String</code> value</td></tr>
227+ * <tr><td><code>"arraybuffer"</code></td><td>contents as a binary <code>ArrayBuffer</code> object</td></tr>
228+ * <tr><td><code>"json"</code></td><td>contents as a parsed <code>JSON</code> object</td></tr>
229+ * </tbody>
230+ * </table>
231+ */
232+
218233 void AssetScriptingInterface::getAsset(QScriptValue options, QScriptValue scope, QScriptValue callback) {
219234 JS_VERIFY(options.isObject() || options.isString(), "expected request options Object or URL as first parameter");
220235
@@ -224,7 +239,7 @@ void AssetScriptingInterface::getAsset(QScriptValue options, QScriptValue scope, · 3 unmodified lines
224239 if (options.isString()) {
225240 url = options.toString();
226241 }
227− if (responseType.isEmpty() || responseType == "string") {
242+ if (responseType.isEmpty()) {
228243 responseType = "text";
229244 }
230245 auto asset = AssetUtils::getATPUrl(url).path();
@@ -389,8 +404,7 @@ bool AssetScriptingInterface::canWriteCacheValue(const QUrl& url) { · 158 unmodified lines
389404 // allow cache writes only from Client, EntityServer and Agent scripts
390405 bool isAllowedContext = (
391406 scriptEngine->isClientScript() ||
392− scriptEngine->isAgentScript() ||
393− scriptEngine->isEntityServerScript()
407+ scriptEngine->isAgentScript()
394408 );
395409 if (!isAllowedContext) {
396410 qCDebug(scriptengine) << __FUNCTION__ << "invalid context" << scriptEngine->getContext() << url;