SharePointStorageオブジェクト
コンポーネント情報 | |
---|---|
version | 8.0.5 |
since | 8.0.0 |
Office 365のSharePointのファイルサービスにアクセスするためのクラスです。
このAPIを利用するためには以下の前提条件を満たしている必要があります。
コンストラクタで指定するプロバイダIDには、上記OAuth プロバイダ設定ファイルにてOffice 365 連携用に設定したプロバイダIDを指定してください。
サイトパスにはこのAPIでドキュメントを扱う Office 365 SharePoint Online 上のサイトパスを指定します。
例えば、チームサイトが「https://yourcompany.sharepoint.com/sites/foo」の場合、サイトパスには "foo" でなく "sites/foo" と記述します。
ユーザコードはOffice 365へアクセスを行う intra-mart Accel Platform ユーザのユーザコードを指定します。
このAPIでは、チームサイト上の「Shared Documents」配下のドキュメントを対象とします。
「Shared Documents」以外のドキュメントライブラリを対象とする場合はコンストラクタの引数にドライブIDを指定します。
ドライブIDは別途Microsoft Graph APIを実行することにより確認が可能です。
GET https://{テナント}.sharepoint.com/_api/v2.0/drives
Office 365 SharePoint Online へアクセスを行う前に、「外部連携アプリケーション」画面にて該当のアプリケーションの利用を許可してください。この操作はアクセスする各ユーザ毎に必要です。
アプリケーションの利用許可が行われていない状態でAPIを実行した場合 エラー(エラーコード:oauth.precondition)が発生します。
このAPIでは、ファイルのID、ファイルサイズ、更新時刻などのメタ情報をキャッシュします。キャッシュは、それらの情報の取得メソッドが実行された際に作成されます。
キャッシュがすでに行われているか確認したい場合はSharePointStorage#hasCache()を、最新の情報を取得したい場合はSharePointStorage#clearCache()を実行後に取得メソッドを実行してください。
このAPIでは、Office365へのデータのアップロード・ダウンロードを行う際にアプリケーションサーバ内に一時ファイルを作成します。
(一時ファイルが作成される場所は、システムプロパティ「-Djava.io.tmpdir」で指定したディレクトリ、ファイル名は「im_office365_[ランダムな文字列]」です。)
一時ファイルは、処理が完了次第自動で削除されますが、処理を行っている最中にアプリケーションサーバが停止した場合、一時ファイルが残留してしまうことがあります。
このクラスのメソッドを実行時に発生したエラーは try ~ catch句でハンドリングすることが可能です。
catchしたエラーオブジェクトは以下のプロパティを保持します。
SharePointStorage APIでは以下のエラーコードを返します。
エラーコードごとに取得可能なエラーデータは以下の通りです。
openAsBinary, createAsBinary, appendAsBinary, openAsText, createAsText, appendAsText API は、ファイルパスに加えて、引数に関数を受け取れるようになっています。
関数を渡して呼び出すことにより、Storage のユーザは close を呼び出す必要がなくなります。
close が、openAsBinary, createAsBinary, appendAsBinary, openAsText, createAsText, appendAsText API により確実に呼び出されることになるため、ファイルの解放漏れを予防できます。
そのため、openAsBinary, createAsBinary, appendAsBinary, openAsText, createAsText, appendAsText API を使用することを推奨します。
例1:
例2:
このAPIを利用するためには以下の前提条件を満たしている必要があります。
- intra-mart Accel Platformのユーザに対応するOffice365ユーザが存在すること
- Microsoft Azure にてアプリケーションが登録・設定されていること
- OAuth プロバイダ設定ファイルにOffice 365 連携を行うための設定が記述されていること
コンストラクタで指定するプロバイダIDには、上記OAuth プロバイダ設定ファイルにてOffice 365 連携用に設定したプロバイダIDを指定してください。
サイトパスにはこのAPIでドキュメントを扱う Office 365 SharePoint Online 上のサイトパスを指定します。
例えば、チームサイトが「https://yourcompany.sharepoint.com/sites/foo」の場合、サイトパスには "foo" でなく "sites/foo" と記述します。
ユーザコードはOffice 365へアクセスを行う intra-mart Accel Platform ユーザのユーザコードを指定します。
このAPIでは、チームサイト上の「Shared Documents」配下のドキュメントを対象とします。
「Shared Documents」以外のドキュメントライブラリを対象とする場合はコンストラクタの引数にドライブIDを指定します。
ドライブIDは別途Microsoft Graph APIを実行することにより確認が可能です。
GET https://{テナント}.sharepoint.com/_api/v2.0/drives
Office 365 SharePoint Online へアクセスを行う前に、「外部連携アプリケーション」画面にて該当のアプリケーションの利用を許可してください。この操作はアクセスする各ユーザ毎に必要です。
アプリケーションの利用許可が行われていない状態でAPIを実行した場合 エラー(エラーコード:oauth.precondition)が発生します。
このAPIでは、ファイルのID、ファイルサイズ、更新時刻などのメタ情報をキャッシュします。キャッシュは、それらの情報の取得メソッドが実行された際に作成されます。
キャッシュがすでに行われているか確認したい場合はSharePointStorage#hasCache()を、最新の情報を取得したい場合はSharePointStorage#clearCache()を実行後に取得メソッドを実行してください。
このAPIでは、Office365へのデータのアップロード・ダウンロードを行う際にアプリケーションサーバ内に一時ファイルを作成します。
(一時ファイルが作成される場所は、システムプロパティ「-Djava.io.tmpdir」で指定したディレクトリ、ファイル名は「im_office365_[ランダムな文字列]」です。)
一時ファイルは、処理が完了次第自動で削除されますが、処理を行っている最中にアプリケーションサーバが停止した場合、一時ファイルが残留してしまうことがあります。
このクラスのメソッドを実行時に発生したエラーは try ~ catch句でハンドリングすることが可能です。
catchしたエラーオブジェクトは以下のプロパティを保持します。
- errorCode : エラーコード。発生したエラーの種類を示すコード。(xxxx.yyyy.zzzz)
- errorMessage : エラーメッセージ。エラーの内容を表すメッセージです。
- errorData : エラーデータ。エラーの内容を補足する情報オブジェクト。形式はエラーコードに準じます。
SharePointStorage APIでは以下のエラーコードを返します。
- oauth.precondition : OAuthアクセストークンを取得する際の事前条件が整っていない
- oauth.provider.config.not.found : OAuthプロバイダ設定が見つからない
- oauth.request : OAuth認可コードグラントフローの処理で認可サーバからエラーレスポンスが返った
- oauth.response.parse : OAuthアクセストークンレスポンスの情報が不正
- oauth : OAuth処理実行中に何らかのエラーが発生した
- office365.request : Office365 OneDrive APIの実行時に予期しないHTTP通信エラーが発生した
- office365.response : Office365 OneDrive APIの実行時に予期しないHTTPエラーレスポンスが返った
- office365.response.api : Office365 OneDrive APIの実行時にSharePointからエラーレスポンスが返った
- office365.provider.setting : Office365 OneDrive APIの実行に必要なプロバイダ設定が行われていない
- io.api.operation : 許可されていない操作が行われた(例えば、ディレクトリに対してファイルに行うべき追記処理を行った場合)
- io.file.not.found : 存在しないファイルに対して操作を行おうとした
- io : 上記以外の問題が発生した
エラーコードごとに取得可能なエラーデータは以下の通りです。
- oauth.request
- statusCode : HTTPレスポンスステータスコード
- error : エラーコード
- errorDescription : エラーの追加テキスト情報(オプショナル)
- errorUri : エラーの追加情報を得ることができるWebページのURI(オプショナル)
- parameters : その他のエラー情報(オプショナル)
- office365.response.api
- statusCode : HTTPレスポンスステータスコード
- errorCode : Office365 Files APIが返すエラーコード
- office365.response
- statusCode : HTTPレスポンスステータスコード
try { var storage = new SharePointStorage('aoyagi', 'provider-00', 'foo/bar'); return storage.list(); } catch (e if e.errorCode == 'oauth.prescondition') { // エラーコードが "oauth.precondition" (OAuthアクセストークンを取得する際の事前条件が整っていない)である場合の処理 // アプリケーションを利用することが許可されていないため、個人設定の外部連携アプリケーション画面で許可することを促すアクションを実装する } catch (e if !isBlank(e.errorCode) && e.errorCode.indexOf('oauth') == 0) { // エラーコードが "oauth" で始まる場合の処理 // OAuth関連の処理でエラーが発生したことに対してのアクションを実装する } // catchしなかった場合は、サーバエラーとなる
openAsBinary, createAsBinary, appendAsBinary, openAsText, createAsText, appendAsText API は、ファイルパスに加えて、引数に関数を受け取れるようになっています。
関数を渡して呼び出すことにより、Storage のユーザは close を呼び出す必要がなくなります。
close が、openAsBinary, createAsBinary, appendAsBinary, openAsText, createAsText, appendAsText API により確実に呼び出されることになるため、ファイルの解放漏れを予防できます。
そのため、openAsBinary, createAsBinary, appendAsBinary, openAsText, createAsText, appendAsText API を使用することを推奨します。
例1:
- 関数を渡さない例
var storage = new SharePointStorage('aoyagi', 'provider-00', 'foo/bar/test.txt'); var reader = storage.openAsText(); // reader は TextReader になります var line; while (line = reader.readLine()) { // 1行ずつ読み込みます Debug.print(line); } reader.close(); // 最後に、close を呼び出し、ストリームを閉じます
- openAsText の引数に、関数を渡す方法
var storage = new SharePointStorage('aoyagi', 'provider-00', 'foo/bar/test.txt'); storage.openAsText(function(reader) { var line; while (line = reader.readLine()) { // 1行ずつ読み込む Debug.print(line); } }); // この時点で reader が自動的に閉じられているので、ユーザは close を書く必要がありません
- eachLine メソッドを用いて一行ずつ表示する例
var storage = new SharePointStorage('aoyagi', 'provider-00', 'foo/bar/test.txt'); storage.openAsText(function(reader) { reader.eachLine(function(line) { // 引数に指定した関数が1行毎に呼ばれます Debug.print(line); }); }); // この時点で reader が自動的に閉じられているので、ユーザは close を書く必要がありません
例2:
- openAsBinary, createAsBinary, appendAsBinary, openAsText, createAsText, appendAsText を使わずにファイルをコピーする例
ストリームを確実に閉じるためには、try ~ finally が必要なことに注目してください。
function copy(src, dest) { var reader = new SharePointStorage('aoyagi', 'provider-00', src).openAsText(undefined, 'UTF-8'); // TextReader を取得します。ファイルの内容は 'UTF-8' として読み込みます try { var writer = new SharePointStorage('aoyagi', 'provider-01', dest).createAsText(undefined, 'UTF-8'); // TextWriter を取得します。ファイルには 'UTF-8' として書き込みます try { reader.transferTo(writer); // transferTo メソッドを使用してデータを転送します } finally { writer.close(); } } finally { reader.close(); } }
- 上記の copy 関数を、openAsText, createAsText に関数を渡す方法で実装した例
openAsText, createAsText が、引数に渡された関数を実行終了後に close を自動的に呼び出すため、try ~ finally を書かずともリソース漏れがなくなります。
function copy(src, dest) { new SharePointStorage('aoyagi', 'provider-00', src).openAsText(function(reader) { new SharePointStorage('aoyagi', 'provider-01', dest).createAsText(function(writer) { reader.transferTo(writer); }, 'UTF-8'); }, 'UTF-8'); }
コンストラクタの概要
SharePointStorage (String userCd , String providerId , String path ) コンストラクタ。トップサイトのストレージを取得します。 |
SharePointStorage (String userCd , String providerId , String sitePath , String path ) コンストラクタ。指定したサイトのストレージを取得します。 |
メソッドの概要
返却値の型 | メソッド名 |
---|---|
ByteWriter | appendAsBinary (Function [callback] ) 追記用として このインスタンスが示すストレージ を開きます。 |
TextWriter | appendAsText (Function [callback] , String [charsetName] ) 追記用として このインスタンスが示すストレージ を開きます。 |
Boolean | append (String src , String [charsetName] ) 文字列を指定されたキャラセット名で変換しこのストレージに追記します。 |
void | clearCache () このインスタンスが示すストレージが持つファイルのメタ情報のキャッシュを削除します。 |
Boolean | copy (SharePointStorage to , Boolean [overwrite] ) このファイル、またはディレクトリを引数で指定された対象にコピーします。 |
ByteWriter | createAsBinary (Function [callback] ) 書き込み用として このインスタンスが示すストレージ を開きます。 |
TextWriter | createAsText (Function [callback] , String [charsetName] ) 書き込み用として このインスタンスが示すストレージ を開きます。 |
String | createdApplicationId () このインスタンスが示すストレージを作成したOffice365上でのアプリケーションIDを返します。 |
String | createdApplicationName () このインスタンスが示すストレージを作成したOffice365上でのアプリケーション名を返します。 |
String | createdUserId () このインスタンスが示すストレージを作成したOffice365上でのユーザIDを返します。 |
String | createdUserName () このインスタンスが示すストレージを作成したOffice365上でのユーザ名を返します。 |
Number | created () このインスタンスが示すストレージを作成した時刻を返します。 |
SharePointStorage[] | directoriesStorages (Boolean [recursive] ) このストレージが示すディレクトリ内のディレクトリを示すストレージのコレクションを返します。 |
String[] | directories (Boolean [recursive] ) このストレージが示すディレクトリの配下にあるディレクトリのパスのコレクションを返します。 |
Boolean | exists () このストレージが示すファイルまたはディレクトリが存在するかどうかを判定します。 |
SharePointStorage[] | filesStorages (Boolean [recursive] ) このストレージが示すディレクトリ内のファイルを示すストレージのコレクションを返します。 |
String[] | files (Boolean [recursive] ) このストレージが示すディレクトリの配下にあるファイルのパスのコレクションを返します。 |
String | getCanonicalPath () 正規化したパスを返します。 |
String | getContentUrl () 非推奨 コンテンツ自体を表すURLを返します。
バージョン8.0.2以後、該当メソッドは必ずnullを返します。ファイルのダウンロードを行う場合は、openAsBinary(Object) または
openAsText(Object, Object)を利用してください。
|
String | getDriveId () ドライブIDを返します。 |
Object | getDrives (String userCd , Object providerId , Object sitePath ) static指定したサイトが保持するドライブの一覧を取得します。 |
String | getId () アイテムIDを返します。 |
Object | getListItemFields () このストレージが示すファイルに対するリストアイテムのフィールド値を取得します。 |
String | getName () このインスタンスが示すストレージの名前を返します。 |
SharePointStorage | getParentStorage () 親ストレージを返します。 |
String | getParent () 親パスを返します。 |
String | getPath () このストレージが示すファイル、または、ディレクトリのパスを返します。 |
String | getProviderId () プロバイダIDを返します。 |
String | getRelativePath (SharePointStorage target ) このストレージとの相対パスを返します。 |
SharePointStorage | getRootStorage () ルートストレージを返します。 |
String | getSitePath () サイトパスを返します。 |
String | getUserCd () Office 365 SharePoint Online へアクセスを行う intra-mart Accel Platform のユーザコードを返します。 |
String | getWebUrl () コンテンツをブラウザ上で確認可能なWeb URLを返します。 |
Boolean | hasCache () ファイルのメタ情報をキャッシュしているか否かを返します。 |
Boolean | isDirectory () このインスタンスが示すストレージがディレクトリであるかどうかを判定します。 |
Boolean | isFile () このインスタンスが示すストレージがファイルかどうかを判定します。 |
String | lastModifiedApplicationId () このインスタンスが示すストレージが最後に変更されたOffice365上でのアプリケーションIDを返します。 |
String | lastModifiedApplicationName () このインスタンスが示すストレージが最後に変更されたOffice365上でのアプリケーション名を返します。 |
String | lastModifiedUserId () このインスタンスが示すストレージが最後に変更されたOffice365上でのユーザIDを返します。 |
String | lastModifiedUserName () このインスタンスが示すストレージが最後に変更されたOffice365上でのユーザ名を返します。 |
Number | lastModified () このインスタンスが示すストレージが最後に変更された時刻を返します。 |
Number | length () このストレージが指定されているファイルの長さを返します。 |
SharePointStorage[] | listStorages (Object [filterOrRecursive] ) このストレージが示すディレクトリ内のファイルおよびディレクトリを示すストレージのコレクションを返します。 |
String[] | list (Object [filterOrRecursive] ) このストレージが示すディレクトリの配下にあるファイル、および、ディレクトリのパスのコレクションを返します。 |
String | loadAs (String format ) このストレージの内容を指定した形式のフォーマットに変換して返します。 |
String | load () 非推奨 このストレージの内容を返します。
旧 API からの置き換えを容易にするために用意してはいますが、新規の開発において、転送するファイルのサイズが大きくならない余程の確信が無い限りは、これらの API を使用しないで下さい。代わりに
openAsBinary, createAsBinary, appendAsBinary, openAsText, createAsText, appendAsText を使用してください
|
Boolean | makeDirectories () このストレージが示すディレクトリを生成します。 |
Boolean | move (String newPath ) このストレージが示すファイルを移動します。 |
ByteReader | openAsBinary (Function [callback] ) 読み込み用として path を開きます。 |
TextReader | openAsText (Function [callback] , String [charsetName] ) 読み込み用として path を開きます。 |
String | read (String [charsetName] ) 非推奨このストレージの内容を指定されたキャラセット名で変換し文字列で返します。
旧 API からの置き換えを容易にするために用意してはいますが、新規の開発において、 転送するファイルのサイズが大きくならない余程の確信が無い限りは、これらの API を使用しないで下さい。代わりに
openAsBinary, createAsBinary, appendAsBinary, openAsText, createAsText, appendAsText を使用してください
|
Boolean | remove (Boolean [recursive] ) このストレージが示すファイルまたはディレクトリを削除します。 |
SharePointStorage | resolve (String other ) このストレージから相対ストレージを返します。 |
Boolean | save (String byteStream ) ファイルの中身をこのストレージに書き込みます。 |
Object | updateListItemFields (Objectフィール値を格納したオブジェクト fields ) このストレージが示すファイルに対するリストアイテムのフィールド値を更新します。 |
Boolean | write (String src , String [charsetName] ) 文字列を指定されたキャラセット名でこのストレージに書き込みます。 |
コンストラクタの詳細
SharePointStorage (String userCd , String providerId , String path )
コンストラクタ。トップサイトのストレージを取得します。
パラメータ
|
SharePointStorage (String userCd , String providerId , String sitePath , String path )
コンストラクタ。指定したサイトのストレージを取得します。
パラメータ
|
メソッドの詳細
ByteWriter appendAsBinary (Function [callback] )
追記用として このインスタンスが示すストレージ を開きます。
callback が渡された場合、callback の第 1 引数に ByteWriter を渡し、ファイルの close は API が自動で行います。
パラメータ
返却値
|
TextWriter appendAsText (Function [callback] , String [charsetName] )
追記用として このインスタンスが示すストレージ を開きます。
callback が渡された場合、callback の第 1 引数に TextWriter を渡し、ファイルの close は API が自動で行います。
パラメータ
返却値
|
Boolean append (String src , String [charsetName] )
文字列を指定されたキャラセット名で変換しこのストレージに追記します。
パラメータ
返却値
|
void clearCache ()
このインスタンスが示すストレージが持つファイルのメタ情報のキャッシュを削除します。
返却値
|
Boolean copy (SharePointStorage to , Boolean [overwrite] )
このファイル、またはディレクトリを引数で指定された対象にコピーします。
このインスタンスのユーザコード、プロバイダID、サイトパスがコピー先のそれらと異なる場合:
パラメータ
返却値
|
ByteWriter createAsBinary (Function [callback] )
書き込み用として このインスタンスが示すストレージ を開きます。
callback が渡された場合、callback の第 1 引数に ByteWriter を渡し、ファイルの close は API が自動で行います。
パラメータ
返却値
|
TextWriter createAsText (Function [callback] , String [charsetName] )
書き込み用として このインスタンスが示すストレージ を開きます。
callback が渡された場合、callback の第 1 引数に TextWriter を渡し、ファイルの close は API が自動で行います。
パラメータ
返却値
|
String createdApplicationId ()
このインスタンスが示すストレージを作成したOffice365上でのアプリケーションIDを返します。
パスが指す場所に何も存在しない場合はnullを返します。
返却値
|
String createdApplicationName ()
このインスタンスが示すストレージを作成したOffice365上でのアプリケーション名を返します。
パスが指す場所に何も存在しない場合はnullを返します。
返却値
|
String createdUserId ()
このインスタンスが示すストレージを作成したOffice365上でのユーザIDを返します。
パスが指す場所に何も存在しない場合はnullを返します。
返却値
|
String createdUserName ()
このインスタンスが示すストレージを作成したOffice365上でのユーザ名を返します。
パスが指す場所に何も存在しない場合はnullを返します。
返却値
|
Number created ()
このインスタンスが示すストレージを作成した時刻を返します。
パスが指す場所に何も存在しない場合は0を返します。
返却値
|
SharePointStorage[] directoriesStorages (Boolean [recursive] )
このストレージが示すディレクトリ内のディレクトリを示すストレージのコレクションを返します。
ディレクトリが空の場合は空コレクションを返します。 このストレージがディレクトリを示さない場合は null を返します。
パラメータ
返却値
|
String[] directories (Boolean [recursive] )
このストレージが示すディレクトリの配下にあるディレクトリのパスのコレクションを返します。
パスは、このストレージのパスからの相対パスです。 ディレクトリが空の場合は空コレクションを返します。 このストレージがディレクトリを示さない場合は null を返します。 ROOT ┗directory-1 ┗directory-1-1 ┣directory-1-1-1 ┃┣directory-1-1-1-1 ┃┗file-1-1-1-2 ┣directory-1-1-2 ┣file-1-1-3 ┗file-1-1-4上記のようなファイル構成である場合、 directory-1-1に対してdirectories(false)を実行した場合の戻り値は以下の通りです。
パラメータ
返却値
|
Boolean exists ()
このストレージが示すファイルまたはディレクトリが存在するかどうかを判定します。
返却値
|
SharePointStorage[] filesStorages (Boolean [recursive] )
このストレージが示すディレクトリ内のファイルを示すストレージのコレクションを返します。
ディレクトリが空の場合は空コレクションを返します。 このストレージがディレクトリを示さない場合は null を返します。
パラメータ
返却値
|
String[] files (Boolean [recursive] )
このストレージが示すディレクトリの配下にあるファイルのパスのコレクションを返します。
パスは、このストレージのパスからの相対パスです。 ディレクトリが空の場合は空コレクションを返します。 このストレージがディレクトリを示さない場合は null を返します。 ROOT ┗directory-1 ┗directory-1-1 ┣directory-1-1-1 ┃┣directory-1-1-1-1 ┃┗file-1-1-1-2 ┣directory-1-1-2 ┣file-1-1-3 ┗file-1-1-4上記のようなファイル構成である場合、 directory-1-1に対してfiles(false)を実行した場合の戻り値は以下の通りです。
パラメータ
返却値
|
String getCanonicalPath ()
正規化したパスを返します。
返却値
|
String getContentUrl ()
非推奨
バージョン8.0.2以後、該当メソッドは必ずnullを返します。ファイルのダウンロードを行う場合は、openAsBinary(Object) または
openAsText(Object, Object)を利用してください。
コンテンツ自体を表すURLを返します。
ディレクトリの場合、または、パスが指す場所に何も存在しない場合はnullを返します。
返却値
|
String getDriveId ()
ドライブIDを返します。
コンストラクタの引数にドライブIDを指定していない場合にはnullが返却されます。
返却値
|
Object getDrives (String userCd , Object providerId , Object sitePath )
static
指定したサイトが保持するドライブの一覧を取得します。
パラメータ
返却値
|
String getId ()
アイテムIDを返します。
パスが指す場所に何も存在しない場合はnullを返します。
返却値
|
Object getListItemFields ()
このストレージが示すファイルに対するリストアイテムのフィールド値を取得します。
返却値
|
String getName ()
このインスタンスが示すストレージの名前を返します。
返却値
|
SharePointStorage getParentStorage ()
親ストレージを返します。
返却値
|
String getParent ()
親パスを返します。
返却値
|
String getPath ()
このストレージが示すファイル、または、ディレクトリのパスを返します。
返却値
|
String getProviderId ()
プロバイダIDを返します。
返却値
|
String getRelativePath (SharePointStorage target )
このストレージとの相対パスを返します。
このインスタンスのユーザコード、プロバイダID、サイトパスがコピー先のそれらと異なる場合:
パラメータ
返却値
|
SharePointStorage getRootStorage ()
ルートストレージを返します。
返却値
|
String getSitePath ()
サイトパスを返します。
返却値
|
String getUserCd ()
Office 365 SharePoint Online へアクセスを行う intra-mart Accel Platform のユーザコードを返します。
返却値
|
String getWebUrl ()
コンテンツをブラウザ上で確認可能なWeb URLを返します。
パスが指す場所に何も存在しない場合はnullを返します。
返却値
|
Boolean hasCache ()
ファイルのメタ情報をキャッシュしているか否かを返します。
返却値
|
Boolean isDirectory ()
このインスタンスが示すストレージがディレクトリであるかどうかを判定します。
返却値
|
Boolean isFile ()
このインスタンスが示すストレージがファイルかどうかを判定します。
返却値
|
String lastModifiedApplicationId ()
このインスタンスが示すストレージが最後に変更されたOffice365上でのアプリケーションIDを返します。
パスが指す場所に何も存在しない場合はnullを返します。
返却値
|
String lastModifiedApplicationName ()
このインスタンスが示すストレージが最後に変更されたOffice365上でのアプリケーション名を返します。
パスが指す場所に何も存在しない場合はnullを返します。
返却値
|
String lastModifiedUserId ()
このインスタンスが示すストレージが最後に変更されたOffice365上でのユーザIDを返します。
パスが指す場所に何も存在しない場合はnullを返します。
返却値
|
String lastModifiedUserName ()
このインスタンスが示すストレージが最後に変更されたOffice365上でのユーザ名を返します。
パスが指す場所に何も存在しない場合はnullを返します。
返却値
|
Number lastModified ()
このインスタンスが示すストレージが最後に変更された時刻を返します。
パスが指す場所に何も存在しない場合は0を返します。
返却値
|
Number length ()
このストレージが指定されているファイルの長さを返します。
パスが指す場所に何も存在しない場合、または、ディレクトリを指している場合は0を返します。
返却値
|
SharePointStorage[] listStorages (Object [filterOrRecursive] )
このストレージが示すディレクトリ内のファイルおよびディレクトリを示すストレージのコレクションを返します。
引数にファイル名フィルタが渡された場合、関数 の第 1 引数に listStoragesを実行した SharePointStorage が、第 2 引数に 対象のファイル名 を渡します。 関数の戻り値がtrueである場合、対象が取得対象となります。 ディレクトリが空の場合は空コレクションを返します。 このストレージがディレクトリを示さない場合は null を返します。
パラメータ
返却値
|
String[] list (Object [filterOrRecursive] )
このストレージが示すディレクトリの配下にあるファイル、および、ディレクトリのパスのコレクションを返します。
パスは、このストレージのパスからの相対パスです。 引数にファイル名フィルタが渡された場合、関数 の第 1 引数に listを実行した SharePointStorage が、第 2 引数に 対象のファイル名 を渡します。 関数の戻り値がtrueである場合、対象が取得対象となります。 ディレクトリが空の場合は空コレクションを返します。 このストレージがディレクトリを示さない場合は null を返します。 ROOT ┗directory-1 ┗directory-1-1 ┣directory-1-1-1 ┃┣directory-1-1-1-1 ┃┗file-1-1-1-2 ┣directory-1-1-2 ┣file-1-1-3 ┗file-1-1-4上記のようなファイル構成である場合、 directory-1-1に対してlist(false)を実行した場合の戻り値は以下の通りです。
パラメータ
返却値
|
String loadAs (String format )
このストレージの内容を指定した形式のフォーマットに変換して返します。
指定できる形式は下記ドキュメントに記載されています。 Query string parameters このメソッドは、指定した形式に変換したファイルの内容をメモリ上に展開します、代替手段は提供していません。
パラメータ
返却値
|
String load ()
非推奨
旧 API からの置き換えを容易にするために用意してはいますが、新規の開発において、転送するファイルのサイズが大きくならない余程の確信が無い限りは、これらの API を使用しないで下さい。代わりに
openAsBinary, createAsBinary, appendAsBinary, openAsText, createAsText, appendAsText を使用してください
このストレージの内容を返します。
返却値
|
Boolean makeDirectories ()
このストレージが示すディレクトリを生成します。
返却値
|
Boolean move (String newPath )
このストレージが示すファイルを移動します。
パラメータ
返却値
|
ByteReader openAsBinary (Function [callback] )
読み込み用として path を開きます。
callback が渡された場合、callback の第 1 引数に ByteReader を渡し、ファイルの close は API が自動で行います。
パラメータ
返却値
|
TextReader openAsText (Function [callback] , String [charsetName] )
読み込み用として path を開きます。
callback が渡された場合、callback の第 1 引数に TextReader を渡し、ファイルの close は API が自動で行います。
パラメータ
返却値
|
String read (String [charsetName] )
非推奨
旧 API からの置き換えを容易にするために用意してはいますが、新規の開発において、 転送するファイルのサイズが大きくならない余程の確信が無い限りは、これらの API を使用しないで下さい。代わりに
openAsBinary, createAsBinary, appendAsBinary, openAsText, createAsText, appendAsText を使用してください
このストレージの内容を指定されたキャラセット名で変換し文字列で返します。
パラメータ
返却値
|
Boolean remove (Boolean [recursive] )
このストレージが示すファイルまたはディレクトリを削除します。
recursive に明示的に true が渡されたときのみ、再帰的に削除します。
パラメータ
返却値
|
SharePointStorage resolve (String other )
このストレージから相対ストレージを返します。
現在のパスから other だけ移動した新しい SharePointStorage を返す。 例: new SharePointStorage('a/b/c').resolve('..') -> 'a/b' を指す SharePointStorage
パラメータ
返却値
|
Boolean save (String byteStream )
ファイルの中身をこのストレージに書き込みます。
パラメータ
返却値
|
Object updateListItemFields (Objectフィール値を格納したオブジェクト fields )
このストレージが示すファイルに対するリストアイテムのフィールド値を更新します。
パラメータ
返却値
|
Boolean write (String src , String [charsetName] )
文字列を指定されたキャラセット名でこのストレージに書き込みます。
パラメータ
返却値
|