ShortCutManagerオブジェクト
| コンポーネント情報 | |
|---|---|
| version | 8.0.7 |
| since | 6.1 |
ショートカット情報オブジェクト。
ショートカット情報の参照、更新を行うマネージャオブジェクトです。
ショートカット情報の参照、更新を行うマネージャオブジェクトです。
コンストラクタの概要
| ShortCutManager () コンストラクタ。 |
ShortCutManager (String groupId) 非推奨コンストラクタ。 |
メソッドの概要
| 返却値の型 | メソッド名 |
|---|---|
| Date | addValidEndDate (Number countDays) 指定日付加算。 |
| String | createShortCut (ShortCutInfo shortCutInfo) ショートカットIDの作成。 |
| Boolean | deleteShortCut (String shortCutId) ショートカットID削除。 |
| String | getErrorPage () ショートカットエラーページ取得。 |
| String | getMainPage () ショートカットメインページ取得。 |
| ShortCutInfo | getShortCutInfo (String shortCutId) ショートカット情報取得。 |
| Boolean | isAllowUser (ShortCutInfo shortcutInfo, String userId) 指定したショートカット情報に対してユーザが許可されているか判定します。 |
| Number | verifyShortCut (Date verifyDate) ショートカット情報を検証し、無効なショートカット情報の削除数を取得。 |
コンストラクタの詳細
| ShortCutManager ()
コンストラクタ。
|
ShortCutManager (String groupId)
非推奨
コンストラクタ。
ショートカット情報オブジェクトを生成します。
パラメータ
|
メソッドの詳細
Date addValidEndDate (Number countDays)
指定日付加算。
SYSTEM日付に指定された日数を加えた日付を取得します。
パラメータ
返却値
|
String createShortCut (ShortCutInfo shortCutInfo)
ショートカットIDの作成。
ショートカット情報を元に固有のIDをキーとしてショートカット情報を登録します。
パラメータ
返却値
|
Boolean deleteShortCut (String shortCutId)
ショートカットID削除。
ショートカットIDを元にショートカット情報を削除します。
パラメータ
返却値
|
|
String getErrorPage ()
ショートカットエラーページ取得。
ショートカットが表示できない場合のエラーページパスを取得します。
返却値
|
|
String getMainPage ()
ショートカットメインページ取得。
ショートカット表示用のメインページパスを取得します。
返却値
|
ShortCutInfo getShortCutInfo (String shortCutId)
ショートカット情報取得。
指定されたショートカットIDからショートカット情報を取得します。
パラメータ
返却値
|
Boolean isAllowUser (ShortCutInfo shortcutInfo, String userId)
指定したショートカット情報に対してユーザが許可されているか判定します。
パラメータ
返却値
|
Number verifyShortCut (Date verifyDate)
ショートカット情報を検証し、無効なショートカット情報の削除数を取得。
指定された日付において無効なショートカット情報を削除し、削除件数を返却します。 取得に失敗した場合は(-1)が返却されます。
パラメータ
返却値
|