パッケージ jp.co.ucm.im.groupmail.api

クラス FolderService

  • public class FolderService
extends Object
    フォルダを操作します。
    導入されたバージョン:
    8.0.0
    バージョン:
    8.0.12
    作成者:
    UCM Co., Ltd.

    • コンストラクタの詳細

      • FolderService

        public FolderService()
        コンストラクター。 初期化処理InitProcess が完了していなければ失敗します。

    • メソッドの詳細

      • create

        @JSFunction
public String create​(String folderName,
                     int sortKey)
        ユーザのトップフォルダを作成します。
        パラメータ:
        folderName - 新しいフォルダの名前
        sortKey - 初期ソートキー
        戻り値:
        作成したフォルダオブジェクト

      • create

        @JSFunction
public String create​(String parentFolderId,
                     String folderName,
                     int sortKey)
        指定のフォルダ配下に新しいフォルダを作成します。
        パラメータ:
        parentFolderId - 親フォルダコード
        folderName - 新しいフォルダの名前
        sortKey - 初期ソートキー
        戻り値:
        作成したフォルダID

      • emptyTrashbox

        public void emptyTrashbox()
        ゴミ箱を空にします。

      • exists

        @JSFunction
public boolean exists​(String folderCd)
        コンテキストのユーザの所有する範囲で引数に指定されたコードのフォルダが存在するかをチェックします。
        パラメータ:
        folderCd - フォルダコード
        戻り値:
        コンテキストのユーザの所有する範囲で存在する場合はtrue

      • get

        @JSFunction
public Folder get​(String folderCd)
        現在のコンテキストのユーザのものの範囲で 引数に指定したフォルダオブジェクトを取得します。
        該当するものが取得できない場合、nullを返します。
        パラメータ:
        folderCd - フォルダコード
        戻り値:
        該当のフォルダオブジェクト、またはnull

      • getPathList

        public List<FolderListNode> getPathList()
        フォルダ階層全体を絶対パス表示にしてリストとして返します。
        戻り値:
        絶対パス表示のフォルダリスト
        導入されたバージョン:
        module 8.0.2 / module-pack 8.0.2

      • getSpecialFolder

        @JSFunction
public Folder getSpecialFolder​(Folder.Category category)
        特殊フォルダ（最上階層）を取得します。
        パラメータ:
        category - カテゴリ
        戻り値:
        FolderWithCategory オブジェクト

      • getTopFolders

        @JSFunction
public List<Folder> getTopFolders()
        現在のコンテキストのユーザのトップフォルダのリストを取得します。
        戻り値:
        トップフォルダのリスト

      • getWholeTree

        @JSFunction
public List<FolderTreeNode> getWholeTree()
        フォルダのルートからのツリーを返します。
        この情報はコンテキストのユーザのルートから末端までのフォルダツリーを返します。 同時に未読件数情報も収集し、返却値に含めます。
        戻り値:
        フォルダツリー情報

      • initialize

        @JSFunction
public void initialize()
        初期フォルダの作成処理を行います。

      • markAllAsRead

        @JSFunction
public void markAllAsRead​(String folderCd)
                   throws GroupMailException
        指定のフォルダ内のメッセージを全て既読にします。
        配下のフォルダは含まれません。
        パラメータ:
        folderCd - 対象のフォルダのフォルダコード
        例外:
        GroupMailException - 指定のフォルダが存在しない場合

      • markAllAsUnerad

        @JSFunction
@Deprecated
public void markAllAsUnerad​(String folderCd)
                     throws GroupMailException
        推奨されていません。
        from 8.0.12 markAllAsUnread(String)
        指定のフォルダ内のメッセージを全て未読にします。
        配下のフォルダは含まれません。
        パラメータ:
        folderCd - 対象のフォルダのフォルダコード
        例外:
        GroupMailException - 指定のフォルダが存在しない場合

      • markAllAsUnread

        @JSFunction
public void markAllAsUnread​(String folderCd)
                     throws GroupMailException
        指定のフォルダ内のメッセージを全て未読にします。
        配下のフォルダは含まれません。
        パラメータ:
        folderCd - 対象のフォルダのフォルダコード
        例外:
        GroupMailException - 指定のフォルダが存在しない場合

      • move

        @JSFunction
public void move​(String targetCd,
                 String newParentCd)
          throws GroupMailException
        フォルダを移動します。
        一番上に移動する場合は moveToTop(java.lang.String) を使用してください。
        特殊フォルダは移動できません。
        移動先に自分配下を指定することも出来ません。
        現在の親フォルダと同じフォルダに移動しようとした場合、エラーにはなりません。
        パラメータ:
        targetCd - 移動するフォルダのコード
        newParentCd - 移動先のフォルダのコード
        例外:
        GroupMailException - 指定のフォルダが存在しない場合、象の移動が出来ない場合

      • moveToTop

        @JSFunction
public void moveToTop​(String folderCd)
               throws GroupMailException
        フォルダを最上階層に移動します。
        特定のフォルダ配下に移動する場合は move(java.lang.String, java.lang.String) を使用してください。 既にトップにある場合は何もしません。
        パラメータ:
        folderCd - 移動するフォルダ
        例外:
        GroupMailException - フォルダが存在しない場合、対象の移動が出来ない場合

      • remove

        @JSFunction
public void remove​(String folderCd)
            throws GroupMailException
        フォルダを削除します。
        • 対象のフォルダがゴミ箱の配下の場合
          • 対象以下のフォルダを全て削除します
          • 対象以下のメッセージを全て削除します
          • 対象以下の添付ファイル・添付ファイル情報を全て削除します
        • 対象のフォルダがゴミ箱以外の配下の場合
          • 対象以下のフォルダをゴミ箱フォルダへ移動します
        コンテキストユーザのものでないフォルダ、特殊フォルダのTOPは削除できません。
        パラメータ:
        folderCd - 削除するフォルダ
        例外:
        GroupMailException - 指定のフォルダが存在しない場合, 指定のフォルダが削除できない場合,ストレージのファイル操作に失敗した場合

      • update

        @JSFunction
public void update​(Folder folder)
            throws GroupMailException
        フォルダの情報を更新します。
        反映されるのは名前とソート番号のみです。
        パラメータ:
        folder - フォルダ情報
        例外:
        GroupMailException - 登録内容に問題画ある場合、または登録に失敗した場合