public class FolderService extends Object
コンストラクタと説明 |
---|
FolderService()
コンストラクター。
|
修飾子とタイプ | メソッドと説明 |
---|---|
String |
create(String folderName,
int sortKey)
ユーザのトップフォルダを作成します。
|
String |
create(String parentFolderId,
String folderName,
int sortKey)
指定のフォルダ配下に新しいフォルダを作成します。
|
void |
emptyTrashbox()
ゴミ箱を空にします。
|
boolean |
exists(String folderCd)
コンテキストのユーザの所有する範囲で引数に指定されたコードのフォルダが存在するかをチェックします。
|
Folder |
get(String folderCd)
現在のコンテキストのユーザのものの範囲で 引数に指定したフォルダオブジェクトを取得します。
|
List<FolderListNode> |
getPathList()
フォルダ階層全体を絶対パス表示にしてリストとして返します。
|
Folder |
getSpecialFolder(Folder.Category category)
特殊フォルダ(最上階層)を取得します。
|
List<Folder> |
getTopFolders()
現在のコンテキストのユーザのトップフォルダのリストを取得します。
|
List<FolderTreeNode> |
getWholeTree()
フォルダのルートからのツリーを返します。
|
void |
initialize()
初期フォルダの作成処理を行います。
|
void |
markAllAsRead(String folderCd)
指定のフォルダ内のメッセージを全て既読にします。
|
void |
markAllAsUnerad(String folderCd)
指定のフォルダ内のメッセージを全て未読にします。
|
void |
move(String targetCd,
String newParentCd)
フォルダを移動します。
|
void |
moveToTop(String folderCd)
フォルダを最上階層に移動します。
|
void |
remove(String folderCd)
フォルダを削除します。
|
void |
update(Folder folder)
フォルダの情報を更新します。
|
@JSFunction public String create(String folderName, int sortKey)
folderName
- 新しいフォルダの名前sortKey
- 初期ソートキー@JSFunction public String create(String parentFolderId, String folderName, int sortKey)
parentFolderId
- 親フォルダコードfolderName
- 新しいフォルダの名前sortKey
- 初期ソートキーpublic void emptyTrashbox()
@JSFunction public boolean exists(String folderCd)
folderCd
- フォルダコード@JSFunction public Folder get(String folderCd)
null
を返します。folderCd
- フォルダコードpublic List<FolderListNode> getPathList()
@JSFunction public Folder getSpecialFolder(Folder.Category category)
category
- カテゴリFolderWithCategory
オブジェクト@JSFunction public List<Folder> getTopFolders()
@JSFunction public List<FolderTreeNode> getWholeTree()
@JSFunction public void initialize()
@JSFunction public void markAllAsRead(String folderCd) throws GroupMailException
folderCd
- 対象のフォルダのフォルダコードGroupMailException
- 指定のフォルダが存在しない場合@JSFunction public void markAllAsUnerad(String folderCd) throws GroupMailException
folderCd
- 対象のフォルダのフォルダコードGroupMailException
- 指定のフォルダが存在しない場合@JSFunction public void move(String targetCd, String newParentCd) throws GroupMailException
moveToTop(java.lang.String)
を使用してください。targetCd
- 移動するフォルダのコードnewParentCd
- 移動先のフォルダのコードGroupMailException
- 指定のフォルダが存在しない場合、象の移動が出来ない場合@JSFunction public void moveToTop(String folderCd) throws GroupMailException
move(java.lang.String, java.lang.String)
を使用してください。
既にトップにある場合は何もしません。folderCd
- 移動するフォルダGroupMailException
- フォルダが存在しない場合、対象の移動が出来ない場合@JSFunction public void remove(String folderCd) throws GroupMailException
folderCd
- 削除するフォルダGroupMailException
- 指定のフォルダが存在しない場合, 指定のフォルダが削除できない場合,ストレージのファイル操作に失敗した場合@JSFunction public void update(Folder folder) throws GroupMailException
folder
- フォルダ情報GroupMailException
- 登録内容に問題画ある場合、または登録に失敗した場合Copyright © 2022 UCM Co., Ltd.. All rights reserved.