文档标注

嵌入使用本文件中提到的简单的JavaScript调用Betalk文档标注模块到你的Web应用程序。

1. 启动文档标注

可选参数Betalk.note包括()API请求

名称 描述
binder_id binderID 指定是否由binder 内容(网页)时注意启动时会自动加载binder ID
page_index 页面索引 指定页面索引如果从binder 的一个特定页面的内容(网页)时,说明是启动时会自动加载
IFRAME True or false 默认为false。指定要开始注意在iframe或在一个新的窗口
border True or false 默认值为true。如果使用的iframe标签里面没有周围的iframe边框指定“假”
scroll True or false 默认为false。如果周围使用的iframe标签添加滚动条内的iframe指定“真”
tagid4iframe iFrame的ID 指定的iframe容器的ID – 适用前提IFRAME在选项设置为“真”
iframewidth iFrame的宽度 宽度剪辑的iFrame的 – 仅适用,如果IFRAME在选项设置为“真”。默认设置为1024px。如果容器控制的宽度,请设置为100%
iframeheight iFrame的高度 剪辑的iFrame的高度 – 仅适用,如果IFRAME在选项设置为“真”。默认设置为768px。如果容器控制的高度,请设置为100%

Betalk开始通过侦听器处理回调事件

事件 描述 属性
start_note 触发笔记成功开始 session_key,SESSION_ID,binder_id
error 触发一个错误的情况下 ERROR_CODE,ERROR_MESSAGE
save_note 当触发用户关闭并保存的笔记 destination_binder_id,share_url,DOWNLOAD_URL
cancel_note 当触发用户关闭并不会保存笔记

启动“note”使用API和一些可选参数

var options = {
    iframe: true,
    start_note: function(event) {
        alert("session key: " + event.session_key + " session id: " + event.session_id);
    },
    error: function(event) {
        alert("error code: " + event.error_code + " message: " + event.error_message);
    },
    save_note: function(event) {
        alert("Note saved: share URL " + event.share_url + " download URL " + event.download_url +
          " destination binder " + event.destination_binder_id);
    },
    cancel_note: function(event) {
        alert("Note cancelled");
    }
};

Betalk.note(options);

 2. 文件上传

使用会话ID和会话密钥参数返回成功启动,你可以将文件上传到正在进行的会话。要使用下面的API实现这个应用程序将文件上传到https://www.Betalk.com(用于生产)或https://sandbox.Betalk.com(对于沙盒):

POST:/board/upload?type=original&sessionid=SESSION_ID&key=SESSION_KEY&name=FILE_NAME
Header Content-Type: application/octet-stream
File Content Sent as the body