| Invalid Date
字数 0阅读时长 1 分钟

1. Class methods

self.new(url_or_fuo, caption: []) →
🧱
PdfBlock

  • [PARAM] url_or_fuo pdf url (String) or file upload object (FileUploadObject)
  • [PARAM(optional)] caption
    • 📃
      The following objects are used for this argument.
      • a String like as “text” (String)
      • an Array of Strings (Array of Strings)
      • a RichTextObject (RichTextObject)
      • an Array of RichTextObjects (Array of RichTextObjects)
      • a RichTextArray (RichTextArray)
self.new creates a PdfBlock object using a url. caption is an optional parameter. Currently, an external file url can be used.

2. Instance methods

save(dry_run: false)

  • [PARAM] dry_run: true if you want to create a verification script
save updates the Block object with update block API. The updated object has block information generated from the JSON response.
Block.find(id, dry_run: true) creates a shell script using Retrieve a block API for verification.

caption →
🎛️
RichTextArray

caption returns the RichTextArray object for PdfBlock.

file_upload_object → FileUploadObject

file_upload_object returns an object for FileUploadObject.

file_upload_object=(file_upload_object)

file_upload_object= updates a FileUploadObject for FileBlock and sets update_block_key of the payload object.

url → String

url returns the url parameter of PdfBlock.

url=(str)

  • [PARAM] str url str
url= updates the url parameter of block for PdfBlock and sets update_block_key of the payload object.
Loading...
目录