Rakuten RMS WEB API client for .NET

< クラス一覧

---

CabinetAPI

Namespace: Rakuten.RMS.Api.CabinetAPI

R-CabinetAPI（CabinetAPI）

public class CabinetAPI : Rakuten.RMS.Api.XML.RakutenApiXmlClientBase

Inheritance Object → RakutenApiClientBaseCommon → RakutenApiXmlClientBase → CabinetAPI

Methods

CreateFolder(String, String, Nullable<Int32>)

public long CreateFolder(string folderName, string directoryName, Nullable<Int32> upperFolderId)

Parameters

folderName String

directoryName String

upperFolderId Nullable<Int32>

Returns

Int64

DeleteFile(Int64)

ファイル削除 成功時はステータスコードを返し、エラー　は例外が発生。

public int DeleteFile(long fileId)

Parameters

fileId Int64

Returns

ステータスコード

Exceptions

XmlStatusException

GetAllFiles(Int64, Int32)

ページング処理を内蔵したバージョン。通常はこちらのメソッド利用を推奨。

public IEnumerable<FileModel> GetAllFiles(long folderId, int pageSize)

Parameters

folderId Int64

pageSize Int32
※値は100まで指定可能

Returns

IEnumerable<FileModel>

GetAllFilesInTrashbox(Int32)

ページングを内蔵したバージョン。

public IEnumerable<FileModel> GetAllFilesInTrashbox(int pageSize)

Parameters

pageSize Int32

Returns

IEnumerable<FileModel>

GetAllFolders(Int32)

ページング処理をラップしたバージョン。通常はこちらのメソッド利用を推奨。

public IEnumerable<FolderModel> GetAllFolders(int pageSize)

Parameters

pageSize Int32
※値は100まで指定可能

Returns

IEnumerable<FolderModel>

GetFiles(Int64, Nullable<Int32>, Nullable<Int32>)

指定したフォルダ内の画像一覧を取得.ページングを内蔵した GetAllFiles を推奨.

public GetFilesResponseModel GetFiles(long folderId, Nullable<Int32> offset, Nullable<Int32> limit)

Parameters

folderId Int64

offset Nullable<Int32>
1を基準値とした検索結果取得ページ数

limit Nullable<Int32>
※最大値100

Returns

GetFilesResponseModel

Exceptions

XmlStatusException

GetFilesInTrashbox(Nullable<Int32>, Nullable<Int32>)

削除フォルダ内にある画像の一覧を取得

public cabinetTrashboxFilesGetResult GetFilesInTrashbox(Nullable<Int32> offset, Nullable<Int32> limit)

Parameters

offset Nullable<Int32>

limit Nullable<Int32>

Returns

cabinetTrashboxFilesGetResult

GetFolders(Nullable<Int32>, Nullable<Int32>)

フォルダの一覧を取得.ページングを内蔵した GetAllFolders を推奨。

public ResultModel GetFolders(Nullable<Int32> offset, Nullable<Int32> limit)

Parameters

offset Nullable<Int32>

limit Nullable<Int32>

Returns

ResultModel

Exceptions

XmlStatusException

GetUsage()

R-Cabinetの利用状況を取得

public CabinetUsageGetResultModel GetUsage()

Returns

CabinetUsageGetResultModel

Exceptions

InvalidOperationException

InsertFile(Int32, String, Stream, String, Nullable<Boolean>)

画像ファイルを指定して画像を登録

public long InsertFile(int folderId, string fileName, Stream file, string filePath, Nullable<Boolean> overWrite)

Parameters

folderId Int32
登録先フォルダID

fileName String
登録画像名 50バイト以内（全角25文字以内/半角50文字以内） 使用禁止文字 ： 機種依存文字（コントロールコード除く）、半角カタカナ 全角スペース → 半角スペースに変換 スペースのみは不可 前後にスペースがある場合は、スペースを自動削除 タグは無効（入力した場合は、タグと判断されたものを削除して表示）

file Stream

filePath String
登録file名
20バイト以内（半角20文字以内）
デフォルト値 ： img[数字8桁].gif / jpg or imgrc[数字10桁].gif / jpg
入力可能文字 ： 半角英数字（小文字）/記号は「-」「_」のみ
使用禁止文字 ： 機種依存文字（コントロールコード含む）、img+8桁の数字、imgrc+10桁の数字
スペースのみ/字間にスペースは不可
前後にスペースがある場合は、スペースは自動削除
タグは無効（入力した場合はタグと判断されたものを削除して表示）

overWrite Nullable<Boolean>
上書きフラグ デフォルト値 ： false

Returns

Int64

RevertFileInTrashbox(Int64, Int32)

削除フォルダ内にある画像を指定したフォルダに戻す

public int RevertFileInTrashbox(long fileId, int folderId)

Parameters

fileId Int64

folderId Int32

Returns

ResultCode

Exceptions

XmlStatusException

SearchAllFiles(Nullable<Int32>, String, String, Nullable<Int32>, String)

ページング処理を内蔵してすべての FileModel を列挙します。

public IEnumerable<FileModel> SearchAllFiles(Nullable<Int32> fileId, string filePath, string fileName, Nullable<Int32> folderId, string folderPath)

Parameters

fileId Nullable<Int32>

filePath String

fileName String

folderId Nullable<Int32>

folderPath String

Returns

IEnumerable<FileModel>

SearchFile(Nullable<Int32>, String, String, Nullable<Int32>, String, Nullable<Int32>, Nullable<Int32>)

public CabinetFilesSearchResultModel SearchFile(Nullable<Int32> fileId, string filePath, string fileName, Nullable<Int32> folderId, string folderPath, Nullable<Int32> offset, Nullable<Int32> limit)

Parameters

fileId Nullable<Int32>

filePath String

fileName String

folderId Nullable<Int32>

folderPath String

offset Nullable<Int32>

limit Nullable<Int32>

Returns

CabinetFilesSearchResultModel

UpdateFile(Int32, String, Stream, String)

画像IDを指定して画像情報を更新

public int UpdateFile(int fileId, string fileName, Stream file, string filePath)

Parameters

fileId Int32
画像ID

fileName String
更新画像名 50バイト以内（全角25文字以内/半角50文字以内） 使用禁止文字：機種依存文字（コントロールコード除く）、半角カタカナ 全角スペース → 半角スペースに変換 スペースのみは不可 前後にスペースがある場合は、スペースを自動削除 タグは無効（入力した場合は、タグと判断されたものを削除して更新）

file Stream

filePath String
更新ファイル名 20バイト以内（半角20文字以内） renameのみmoveはしない 登録時にdefaultで設定した場合、img + 別数字,imgrc + 別数字の形式へは変更不可 登録時と同じ値は指定不可 入力可能な文字は、半角英数字（小文字）/記号は「-」「_」のみ 使用禁止文字：機種依存文字（コントロールコード含む）、img+8桁の数字、imgrc+10桁の数字 スペースのみ/字間にスペースは不可(スペースのみの場合は更新しない) 前後にスペースがある場合は、スペースは自動削除 タグは無効（入力した場合はタグと判断されたものを削除して更新）

Returns

ResultCode

---

< クラス一覧