コンストラクタの概要

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)
コンストラクタ。トップサイトのストレージを取得します。
パラメータ
userCd : String
ユーザコード。
providerId : String
OAuthプロバイダのID
path : String
SharePointのドキュメントのパス
SharePointStorage (String userCd, String providerId, String sitePath, String path)
コンストラクタ。指定したサイトのストレージを取得します。
パラメータ
userCd : String
ユーザコード。
providerId : String
OAuthプロバイダのID
sitePath : String
サイトのパス
path : String
SharePointのドキュメントのパス

メソッドの詳細

ByteWriter appendAsBinary (Function [callback])
追記用として このインスタンスが示すストレージ を開きます。
callback が渡された場合、callback の第 1 引数に ByteWriter を渡し、ファイルの close は API が自動で行います。
パラメータ
[callback] : Function
コールバック関数
返却値
ByteWriter
ByteWriter 生成した ByteWriter。
TextWriter appendAsText (Function [callback], String [charsetName])
追記用として このインスタンスが示すストレージ を開きます。
callback が渡された場合、callback の第 1 引数に TextWriter を渡し、ファイルの close は API が自動で行います。
パラメータ
[callback] : Function
コールバック関数
[charsetName] : String
書き込み時のキャラセット名
返却値
TextWriter
TextWriter 生成した TextWriter。
Boolean append (String src, String [charsetName])
文字列を指定されたキャラセット名で変換しこのストレージに追記します。
パラメータ
src : String
文字列
[charsetName] : String
キャラセット名(省略時はUTF-8を利用します。)
返却値
Boolean
Boolean 成功した場合はtrue
void clearCache ()
このインスタンスが示すストレージが持つファイルのメタ情報のキャッシュを削除します。
返却値
void
Boolean copy (SharePointStorage to, Boolean [overwrite])
このファイル、またはディレクトリを引数で指定された対象にコピーします。
このインスタンスのユーザコード、プロバイダID、サイトパスがコピー先のそれらと異なる場合:
  • エラー(エラーコード "io.api.operation")がスローされます。
このインスタンスが示すストレージが存在しない場合:
  • エラー(エラーコード "io.file.not.found")がスローされます。
このインスタンスが示すストレージがファイルの場合:
  • toが存在しない場合はtoに対してコピーを行います。
  • toがファイルの場合は、引数overwriteに従います。
  • toがディレクトリの場合はエラー(エラーコード "io.api.operation")がスローされます。
このインスタンスが示すストレージがディレクトリの場合:
  • toが存在しない場合はtoディレクトリを作成し、コピーを行います。
  • toがファイルの場合はエラー(エラーコード "io.api.operation")がスローされます。
  • toがディレクトリの場合、かつtoディレクトリ配下にファイルまたはディレクトリが存在した場合は引数overwriteに従います。
    このインスタンス配下のファイルと同名の階層のディレクトリがコピー先に存在した場合はエラー(エラーコード "io.api.operation")がスローされます。
  • toがディレクトリの場合、かつtoディレクトリ配下にファイルまたはディレクトリが存在していない場合はこのインスタンス配下のファイルまたはディレクトリをtoディレクトリ配下にコピーします。
  • toがディレクトリの場合、かつこのインスタンス配下のファイルと一致しないファイルがtoディレクトリ配下に存在した場合は、そのファイルに対しては何も行われません。
    (mergeする動作となります、削除が必要な場合はコピー先に対して remove(boolean) を呼び出した後このメソッドを実行して下さい)
パラメータ
to : SharePointStorage
コピー先
[overwrite] : Boolean
trueの場合上書きします
返却値
Boolean
Boolean 成功した場合はtrue
ByteWriter createAsBinary (Function [callback])
書き込み用として このインスタンスが示すストレージ を開きます。
callback が渡された場合、callback の第 1 引数に ByteWriter を渡し、ファイルの close は API が自動で行います。
パラメータ
[callback] : Function
コールバック関数
返却値
ByteWriter
ByteWriter 生成した ByteWriter。
TextWriter createAsText (Function [callback], String [charsetName])
書き込み用として このインスタンスが示すストレージ を開きます。
callback が渡された場合、callback の第 1 引数に TextWriter を渡し、ファイルの close は API が自動で行います。
パラメータ
[callback] : Function
コールバック関数
[charsetName] : String
書き込み時のキャラセット名
返却値
TextWriter
TextWriter 生成した TextWriter。
String createdApplicationId ()
このインスタンスが示すストレージを作成したOffice365上でのアプリケーションIDを返します。
パスが指す場所に何も存在しない場合はnullを返します。
返却値
String
String 作成したアプリケーションID。
String createdApplicationName ()
このインスタンスが示すストレージを作成したOffice365上でのアプリケーション名を返します。
パスが指す場所に何も存在しない場合はnullを返します。
返却値
String
String 作成したアプリケーション名。
String createdUserId ()
このインスタンスが示すストレージを作成したOffice365上でのユーザIDを返します。
パスが指す場所に何も存在しない場合はnullを返します。
返却値
String
String 作成したユーザID。
String createdUserName ()
このインスタンスが示すストレージを作成したOffice365上でのユーザ名を返します。
パスが指す場所に何も存在しない場合はnullを返します。
返却値
String
String 作成したユーザ名。
Number created ()
このインスタンスが示すストレージを作成した時刻を返します。
パスが指す場所に何も存在しない場合は0を返します。
返却値
Number
Number ファイルが作成された時刻を表す long 値。エポック (1970 年 1 月 1 日 0 時 0 分 0 秒、グリニッジ標準時) からミリ秒単位で測定。
SharePointStorage[] directoriesStorages (Boolean [recursive])
このストレージが示すディレクトリ内のディレクトリを示すストレージのコレクションを返します。
ディレクトリが空の場合は空コレクションを返します。
このストレージがディレクトリを示さない場合は null を返します。
パラメータ
[recursive] : Boolean
ディレクトリを再帰的に探索する場合は true、そうでない場合は false(省略時はdirectoriesStorages(false) と同値。)
返却値
SharePointStorage[]
SharePointStorage[] このストレージが示すディレクトリ内のディレクトリを示すストレージのコレクション。
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)を実行した場合の戻り値は以下の通りです。
  • directory-1-1-1
  • directory-1-1-2
directory-1-1に対してdirectories(true)を実行した場合の戻り値は以下の通りです。
  • directory-1-1-1
  • directory-1-1-1/directory-1-1-1-1
  • directory-1-1-2
パラメータ
[recursive] : Boolean
ディレクトリを再帰的に探索する場合は true、そうでない場合は false(省略時はdirectories(false) と同値。)
返却値
String[]
String[] このストレージが示すディレクトリの配下にあるディレクトリのパスのコレクション
Boolean exists ()
このストレージが示すファイルまたはディレクトリが存在するかどうかを判定します。
返却値
Boolean
Boolean ファイルまたはディレクトリが存在する場合は true、そうでない場合は false
SharePointStorage[] filesStorages (Boolean [recursive])
このストレージが示すディレクトリ内のファイルを示すストレージのコレクションを返します。
ディレクトリが空の場合は空コレクションを返します。
このストレージがディレクトリを示さない場合は null を返します。
パラメータ
[recursive] : Boolean
ディレクトリを再帰的に探索する場合は true、そうでない場合は false(省略時はfilesStorages(false) と同値。)
返却値
SharePointStorage[]
SharePointStorage[] このストレージが示すディレクトリ内のファイルを示すストレージのコレクション。
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)を実行した場合の戻り値は以下の通りです。
  • file-1-1-3
  • file-1-1-4
directory-1-1に対してfiles(true)を実行した場合の戻り値は以下の通りです。
  • directory-1-1-1/file-1-1-1-2
  • file-1-1-3
  • file-1-1-4
パラメータ
[recursive] : Boolean
ディレクトリを再帰的に探索する場合は true、そうでない場合は false(省略時はfiles(false) と同値。)
返却値
String[]
String[] このストレージが示すディレクトリの配下にあるファイルのパスのコレクション
String getCanonicalPath ()
正規化したパスを返します。
返却値
String
String 正規化したパス
String getContentUrl () 非推奨
バージョン8.0.2以後、該当メソッドは必ずnullを返します。ファイルのダウンロードを行う場合は、openAsBinary(Object) または openAsText(Object, Object)を利用してください。
コンテンツ自体を表すURLを返します。
ディレクトリの場合、または、パスが指す場所に何も存在しない場合はnullを返します。
返却値
String
String コンテンツ自体を表すURL
String getDriveId ()
ドライブIDを返します。
コンストラクタの引数にドライブIDを指定していない場合にはnullが返却されます。
返却値
String
String ドライブID
Object getDrives (String userCd, Object providerId, Object sitePath) static
指定したサイトが保持するドライブの一覧を取得します。
パラメータ
userCd : String
ドライブ一覧を取得する際に利用するMicrosoft 365連携済のユーザコード
providerId : Object
OAuth連携プロバイダID
sitePath : Object
サイトパス ("site/xxx"形式) この引数はオプショナルです。
返却値
Object
Object このストレージが示すファイルに対するリストアイテムの更新されたフィールド値オブジェクト
String getId ()
アイテムIDを返します。
パスが指す場所に何も存在しない場合はnullを返します。
返却値
String
String Office365でのID
Object getListItemFields ()
このストレージが示すファイルに対するリストアイテムのフィールド値を取得します。
返却値
Object
Object このストレージが示すファイルに対するリストアイテムのフィールド値オブジェクト
String getName ()
このインスタンスが示すストレージの名前を返します。
返却値
String
String ファイルまたはディレクトリの名前
SharePointStorage getParentStorage ()
親ストレージを返します。
返却値
SharePointStorage
SharePointStorage 親ストレージ。このストレージがルートストレージだった場合は、null を返します。
String getParent ()
親パスを返します。
返却値
String
String 親パス。このストレージがルートストレージだった場合は、null を返します。
String getPath ()
このストレージが示すファイル、または、ディレクトリのパスを返します。
返却値
String
String パス
String getProviderId ()
プロバイダIDを返します。
返却値
String
String プロバイダID
String getRelativePath (SharePointStorage target)
このストレージとの相対パスを返します。
このインスタンスのユーザコード、プロバイダID、サイトパスがコピー先のそれらと異なる場合:
  • エラー(エラーコード "io.api.operation")がスローされます。
パラメータ
target : SharePointStorage
比較対象ストレージ
返却値
String
String このストレージとの相対パスを返します。
SharePointStorage getRootStorage ()
ルートストレージを返します。
返却値
SharePointStorage
SharePointStorage ルートストレージ
String getSitePath ()
サイトパスを返します。
返却値
String
String サイトパス
String getUserCd ()
Office 365 SharePoint Online へアクセスを行う intra-mart Accel Platform のユーザコードを返します。
返却値
String
String ユーザコード
String getWebUrl ()
コンテンツをブラウザ上で確認可能なWeb URLを返します。
パスが指す場所に何も存在しない場合はnullを返します。
返却値
String
String Web URL
Boolean hasCache ()
ファイルのメタ情報をキャッシュしているか否かを返します。
返却値
Boolean
Boolean キャッシュが存在する場合は true
Boolean isDirectory ()
このインスタンスが示すストレージがディレクトリであるかどうかを判定します。
返却値
Boolean
Boolean このインスタンスが示すストレージが存在し、さらにそれがディレクトリである場合は true、そうでない場合は false
Boolean isFile ()
このインスタンスが示すストレージがファイルかどうかを判定します。
返却値
Boolean
Boolean このインスタンスが示すストレージが存在し、さらにそれがファイルである場合は true、そうでない場合は false
String lastModifiedApplicationId ()
このインスタンスが示すストレージが最後に変更されたOffice365上でのアプリケーションIDを返します。
パスが指す場所に何も存在しない場合はnullを返します。
返却値
String
String 作成したアプリケーションID。
String lastModifiedApplicationName ()
このインスタンスが示すストレージが最後に変更されたOffice365上でのアプリケーション名を返します。
パスが指す場所に何も存在しない場合はnullを返します。
返却値
String
String 作成したアプリケーション名。
String lastModifiedUserId ()
このインスタンスが示すストレージが最後に変更されたOffice365上でのユーザIDを返します。
パスが指す場所に何も存在しない場合はnullを返します。
返却値
String
String 作成したユーザID。
String lastModifiedUserName ()
このインスタンスが示すストレージが最後に変更されたOffice365上でのユーザ名を返します。
パスが指す場所に何も存在しない場合はnullを返します。
返却値
String
String 作成したユーザ名。
Number lastModified ()
このインスタンスが示すストレージが最後に変更された時刻を返します。
パスが指す場所に何も存在しない場合は0を返します。
返却値
Number
Number ファイルが最後に変更された時刻を表す long 値。エポック (1970 年 1 月 1 日 0 時 0 分 0 秒、グリニッジ標準時) からミリ秒単位で測定。
Number length ()
このストレージが指定されているファイルの長さを返します。
パスが指す場所に何も存在しない場合、または、ディレクトリを指している場合は0を返します。
返却値
Number
Number このストレージが示すファイルの長さ (単位はバイト)。
SharePointStorage[] listStorages (Object [filterOrRecursive])
このストレージが示すディレクトリ内のファイルおよびディレクトリを示すストレージのコレクションを返します。
引数にファイル名フィルタが渡された場合、関数 の第 1 引数に listStoragesを実行した SharePointStorage が、第 2 引数に 対象のファイル名 を渡します。
関数の戻り値がtrueである場合、対象が取得対象となります。
ディレクトリが空の場合は空コレクションを返します。
このストレージがディレクトリを示さない場合は null を返します。
パラメータ
[filterOrRecursive] : Object
どちらかを指定できます。(省略時はlistStorages(false) と同値。)
  • recursiveを指定する場合:Boolean ディレクトリを再帰的に探索する場合は true、そうでない場合は false
  • filterを指定する場合:Function ファイル名フィルタ
返却値
SharePointStorage[]
SharePointStorage[] このストレージが示すディレクトリ内のファイルおよびディレクトリを示すストレージのコレクション。
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)を実行した場合の戻り値は以下の通りです。
  • directory-1-1-1
  • directory-1-1-2
  • file-1-1-3
  • file-1-1-4
directory-1-1に対してlist(true)を実行した場合の戻り値は以下の通りです。
  • directory-1-1-1
  • directory-1-1-1/directory-1-1-1-1
  • directory-1-1-1/file-1-1-1-2
  • directory-1-1-2
  • file-1-1-3
  • file-1-1-4
パラメータ
[filterOrRecursive] : Object
どちらかを指定できます。(省略時はlist(false) と同値。)
  • recursiveを指定する場合:Boolean ディレクトリを再帰的に探索する場合は true、そうでない場合は false
  • filterを指定する場合:Function ファイル名フィルタ
返却値
String[]
String[] このストレージが示すディレクトリにあるファイルおよびディレクトリ名のコレクション、または、ファイルおよびディレクトリパスのコレクション。
String loadAs (String format)
このストレージの内容を指定した形式のフォーマットに変換して返します。
指定できる形式は下記ドキュメントに記載されています。 Query string parameters
このメソッドは、指定した形式に変換したファイルの内容をメモリ上に展開します、代替手段は提供していません。
パラメータ
format : String
フォーマット
返却値
String
String ストレージの内容
String load () 非推奨
旧 API からの置き換えを容易にするために用意してはいますが、新規の開発において、転送するファイルのサイズが大きくならない余程の確信が無い限りは、これらの API を使用しないで下さい。代わりに openAsBinary, createAsBinary, appendAsBinary, openAsText, createAsText, appendAsText を使用してください
このストレージの内容を返します。
返却値
String
String ストレージの内容
Boolean makeDirectories ()
このストレージが示すディレクトリを生成します。
返却値
Boolean
Boolean 必要なすべての親ディレクトリを含めてディレクトリが生成された場合は true、そうでない場合は false
Boolean move (String newPath)
このストレージが示すファイルを移動します。
パラメータ
newPath : String
このストレージの新しいパス
返却値
Boolean
Boolean 移動が成功した場合は true、そうでない場合は false
ByteReader openAsBinary (Function [callback])
読み込み用として path を開きます。
callback が渡された場合、callback の第 1 引数に ByteReader を渡し、ファイルの close は API が自動で行います。
パラメータ
[callback] : Function
コールバック関数
返却値
ByteReader
ByteReader 生成した ByteReader。
TextReader openAsText (Function [callback], String [charsetName])
読み込み用として path を開きます。
callback が渡された場合、callback の第 1 引数に TextReader を渡し、ファイルの close は API が自動で行います。
パラメータ
[callback] : Function
コールバック関数
[charsetName] : String
読み込み時のキャラセット名
返却値
TextReader
TextReader 生成した TextReader。
String read (String [charsetName]) 非推奨
旧 API からの置き換えを容易にするために用意してはいますが、新規の開発において、 転送するファイルのサイズが大きくならない余程の確信が無い限りは、これらの API を使用しないで下さい。代わりに openAsBinary, createAsBinary, appendAsBinary, openAsText, createAsText, appendAsText を使用してください
このストレージの内容を指定されたキャラセット名で変換し文字列で返します。
パラメータ
[charsetName] : String
キャラセット名(省略時はUTF-8を利用します。)
返却値
String
String ストレージの内容の文字列
Boolean remove (Boolean [recursive])
このストレージが示すファイルまたはディレクトリを削除します。
recursive に明示的に true が渡されたときのみ、再帰的に削除します。
パラメータ
[recursive] : Boolean
ディレクトリを再帰的に探索する場合は true、そうでない場合は false(省略時はremove(false)と同値。)
返却値
Boolean
Boolean ファイルまたはディレクトリが正常に削除された場合は true、そうでない場合は false
SharePointStorage resolve (String other)
このストレージから相対ストレージを返します。
現在のパスから other だけ移動した新しい SharePointStorage を返す。
例:
 new SharePointStorage('a/b/c').resolve('..') -> 'a/b' を指す SharePointStorage
 
パラメータ
other : String
このストレージからの相対パス
返却値
SharePointStorage
SharePointStorage このストレージからの相対ストレージ
Boolean save (String byteStream)
ファイルの中身をこのストレージに書き込みます。
パラメータ
byteStream : String
ファイルの中身
返却値
Boolean
Boolean 成功した場合はtrue
Object updateListItemFields (Objectフィール値を格納したオブジェクト fields)
このストレージが示すファイルに対するリストアイテムのフィールド値を更新します。
パラメータ
fields : Objectフィール値を格納したオブジェクト
Objectフィール値を格納したオブジェクト
返却値
Object
Object このストレージが示すファイルに対するリストアイテムの更新されたフィールド値オブジェクト
Boolean write (String src, String [charsetName])
文字列を指定されたキャラセット名でこのストレージに書き込みます。
パラメータ
src : String
文字列
[charsetName] : String
キャラセット名(省略時はUTF-8を利用します。)
返却値
Boolean
Boolean 成功した場合はtrue