couchbeam_attachments.md

Module couchbeam_attachments

• Description
• Function Index
• Function Details

This module contains utilities to manage attachments.

Function Index

add_inline/3	add attachment to a doc and encode it.
add_inline/4	add attachment to a doc and encode it with ContentType fixed.
add_stub/3
delete_inline/2	delete an attachment record in doc.

Function Details

add_inline/3

add_inline(Doc::json_obj(), Content::attachment_content(), AName::string()) -> json_obj()

add attachment to a doc and encode it. Give possibility to send attachments inline.

add_inline/4

add_inline(Doc::json_obj(), Content::attachment_content(), AName::string(), ContentType::string()) -> json_obj()

add attachment to a doc and encode it with ContentType fixed.

add_stub/3

add_stub(Doc, Name, ContentType) -> any()

delete_inline/2

delete_inline(Doc::json_obj(), AName::string()) -> json_obj()

delete an attachment record in doc. This is different from delete_attachment change is only applied in Doc object. Save_doc should be save to save changes.