crib-enable-interface.html 1.5 KB
Newer Older
1 2 3 4 5 6 7 8 9
<!DOCTYPE html>
<html>
  <head>
    <title>Crib Enable Interface</title>
  </head>
  <body>
    <h1>Crib Enable Interface</h1>
    <h3>Interface Needed to edit with CribJS</h3>
    <dl>
10 11 12
      <dt>getScope</dt>
      <dd>Return url in string format. get the Scope covered by the gadget</dd>
      <dl></dl>
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
      <dt>get</dt>
      <dd>Return a data url. Cannot return a blob as the data is transmitted through an iFrame</dd>
      <dl>
        <dt data-parameter-required="required" data-parameter-type="string">url</dt>
        <dd>url of the document to retrieve</dd>
      </dl>
      <dt>put</dt>
      <dd>Return a data url. Cannot provide a blob as the data is transmitted through an iFrame</dd>
      <dl>
        <dt data-parameter-required="required" data-parameter-type="string">url</dt>
        <dd>url of the document to update</dd>
        <dt data-parameter-required="required" data-parameter-type="data-uri">parameter</dt>
        <dd>data url of the document to put, it will be transformed in a blob</dd>
      </dl>
      <dt>allDocs</dt>
      <dd>return the list of document in the cache</dd>
      <dl>
        <dt  data-parameter-required="optional" data-parameter-type="object">option_dict</dt>
        <dd>XXX Not Taken into account at the moment</dd>
      </dl>
      <dt>remove</dt>
      <dd>Remove an url from the cache</dd>
      <dl>
        <dt data-parameter-required="required" data-parameter-type="string">url</dt>
        <dd>url of the document to update</dd>
      </dl>
    </dl>
  </body>
</html>