はじめに
hkob の雑記録の第183回目は、NotionRubyMapping の FileUploadObject のマニュアルを執筆します。
FileUploadObject のマニュアル
とりあえず、一番近そうな FileObject のマニュアルを複製しました。あらかじめ複製したページのリンクを示しておきます。以下では、マニュアルを部分ごとにスクリーンショットで紹介します。
リンク集の修正
最初にタイトルとリンク一覧があります。みてわかるようにリンク集の部分は同期ブロックとなっており、一箇所だけ直せばいいようになっています。今回は、FileObject の隣に FileUploadObject を置きました。
以前は全てのページに目次が設置されていました。しかし、今は上のスクリーンショットに見えるように右側に目次が用意されています。この後、全てのページの目次を削除していこうと思います。
Constructor の説明
最初はコンストラクタの説明です。ユーザから見た場合、ローカルのファイルをアップロードするか、外部 URL を指定するかの二択です。外部 URL の場合にもファイル名は必要なので、fname は必須の引数、external_url は optional な引数となります。Notion API では 20MB を超えた場合には別の処理が必要となっていますが、NotionRubyMapping では内部で違いを吸収するので、ファイル名を単に指定するだけでよいです。10MB を超えた場合には、内部で10MB ずつにファイルを分割して、複数回のアップロードを実施します。
一方、外部 URL を与えた場合にはすぐに処理が終わります。それは Notion のサーバ側で自動的に取り込み処理が行われるからです。ただし、アップロードが終わったことは、status を確認する必要があります。返却後の FileUploadObject の status は pending になっているので、適当なタイミングののちに reload して status を確認する必要があります。
Instance methods の説明
すでに Constructor に記載していますが、reload と status というインスタンスメソッドがあります。特にこれ以上説明するものはなさそうです。
おわりに
いま、全体的にマニュアルを確認しましたが、全てのページに目次が用意されているなど、古い表記のものがかなり残っています。どちらにしても icon や image など、ファイルが絡む部分に FileUploadObject が引数で渡せるように変わっているので、それらの追記が必要です。その際にページの体裁も一緒に修正していきたいと思います。
