openEventsPlatformApp/plugins/cordova-plugin-file/www/FileUploadOptions.js
plugins/cordova-plugin-file/www/FileUploadOptions.jsRaw
1/*
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20*/
21
22/**
23 * Options to customize the HTTP request used to upload files.
24 * @constructor
25 * @param fileKey {String} Name of file request parameter.
26 * @param fileName {String} Filename to be used by the server. Defaults to image.jpg.
27 * @param mimeType {String} Mimetype of the uploaded file. Defaults to image/jpeg.
28 * @param params {Object} Object with key: value params to send to the server.
29 * @param headers {Object} Keys are header names, values are header values. Multiple
30 * headers of the same name are not supported.
31 */
32var FileUploadOptions = function(fileKey, fileName, mimeType, params, headers, httpMethod) {
33 this.fileKey = fileKey || null;
34 this.fileName = fileName || null;
35 this.mimeType = mimeType || null;
36 this.params = params || null;
37 this.headers = headers || null;
38 this.httpMethod = httpMethod || null;
39};
40
41module.exports = FileUploadOptions;