KSHTTPMultipartPostBody.h 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. //
  2. // KSHTTPMultipartPostBody.h
  3. //
  4. // Created by Karl Stenerud on 2012-02-19.
  5. //
  6. // Copyright (c) 2012 Karl Stenerud. All rights reserved.
  7. //
  8. // Permission is hereby granted, free of charge, to any person obtaining a copy
  9. // of this software and associated documentation files (the "Software"), to deal
  10. // in the Software without restriction, including without limitation the rights
  11. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12. // copies of the Software, and to permit persons to whom the Software is
  13. // furnished to do so, subject to the following conditions:
  14. //
  15. // The above copyright notice and this permission notice shall remain in place
  16. // in this source code.
  17. //
  18. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  24. // THE SOFTWARE.
  25. //
  26. #import <Foundation/Foundation.h>
  27. /**
  28. * Builds a multipart MIME HTTP body.
  29. */
  30. @interface KSHTTPMultipartPostBody: NSObject
  31. /** The content-type identifier for this body. */
  32. @property(nonatomic,readonly,retain) NSString* contentType;
  33. /** Constructor.
  34. *
  35. * @return A new body.
  36. */
  37. + (KSHTTPMultipartPostBody*) body;
  38. /** This body's data, encoded for sending in an HTTP request. */
  39. - (NSData*) data;
  40. /** Append a new data field to the body.
  41. *
  42. * @param data The data to append.
  43. *
  44. * @param name The field name.
  45. *
  46. * @param contentType The field's content-type (nil = omit).
  47. *
  48. * @param filename The field's filename (nil = omit).
  49. */
  50. - (void) appendData:(NSData*) data
  51. name:(NSString*) name
  52. contentType:(NSString*) contentType
  53. filename:(NSString*) filename;
  54. /** Append a new UTF-8 encoded string field to the body.
  55. *
  56. * @param string The string to append.
  57. *
  58. * @param name The field name.
  59. *
  60. * @param contentType The field's content-type (nil = omit).
  61. *
  62. * @param filename The field's filename (nil = omit).
  63. */
  64. - (void) appendUTF8String:(NSString*) string
  65. name:(NSString*) name
  66. contentType:(NSString*) contentType
  67. filename:(NSString*) filename;
  68. @end