FileUploadOptions.js 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  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. * Options to customize the HTTP request used to upload files.
  23. * @constructor
  24. * @param fileKey {String} Name of file request parameter.
  25. * @param fileName {String} Filename to be used by the server. Defaults to image.jpg.
  26. * @param mimeType {String} Mimetype of the uploaded file. Defaults to image/jpeg.
  27. * @param params {Object} Object with key: value params to send to the server.
  28. * @param headers {Object} Keys are header names, values are header values. Multiple
  29. * headers of the same name are not supported.
  30. */
  31. var FileUploadOptions = function(fileKey, fileName, mimeType, params, headers, httpMethod) {
  32. this.fileKey = fileKey || null;
  33. this.fileName = fileName || null;
  34. this.mimeType = mimeType || null;
  35. this.params = params || null;
  36. this.headers = headers || null;
  37. this.httpMethod = httpMethod || null;
  38. };
  39. module.exports = FileUploadOptions;