コンストラクタの概要

ShortCutManager ()
コンストラクタ。
ShortCutManager (String groupId) 非推奨
コンストラクタ。

メソッドの概要

返却値の型 メソッド名
Date addValidEndDate (String 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) 非推奨
コンストラクタ。

ショートカット情報オブジェクトを生成します。
パラメータ
groupId : String
ログイングループID

メソッドの詳細

Date addValidEndDate (String countDays)
指定日付加算。

SYSTEM日付に指定された日数を加えた日付を取得します。
パラメータ
countDays : String
指定日数
返却値
Date
Date 指定日付
エラー発生時はNULLを返します。
String createShortCut (ShortCutInfo shortCutInfo)
ショートカットIDの作成。

ショートカット情報を元に固有のIDをキーとしてショートカット情報を登録します。
パラメータ
shortCutInfo : ShortCutInfo
ショートカット情報オブジェクト
返却値
String
String 作成されたショートカットID
Boolean deleteShortCut (String shortCutId)
ショートカットID削除。

ショートカットIDを元にショートカット情報を削除します。
パラメータ
shortCutId : String
ショートカットID
返却値
Boolean
Boolean ショートカットIDの削除に成功(true) / ショートカットIDの削除に失敗(false)
String getErrorPage ()
ショートカットエラーページ取得。

ショートカットが表示できない場合のエラーページパスを取得します。
返却値
String
String エラーページパス
エラー発生時はNULLを返します。
String getMainPage ()
ショートカットメインページ取得。

ショートカット表示用のメインページパスを取得します。
返却値
String
String メインページパス
エラー発生時はNULLを返します。
ShortCutInfo getShortCutInfo (String shortCutId)
ショートカット情報取得。

指定されたショートカットIDからショートカット情報を取得します。
パラメータ
shortCutId : String
ショートカットID
返却値
ShortCutInfo
ShortCutInfo ショートカット情報オブジェクト
存在しない場合およびエラー発生時はNULLを返します。
Boolean isAllowUser (ShortCutInfo shortcutInfo, String userId)
指定したショートカット情報に対してユーザが許可されているか判定します。
パラメータ
shortcutInfo : ShortCutInfo
ショートカット情報
userId : String
ユーザID
返却値
Boolean
Boolean 許可されたユーザであるなら true。
Number verifyShortCut (Date verifyDate)
ショートカット情報を検証し、無効なショートカット情報の削除数を取得。

指定された日付において無効なショートカット情報を削除し、削除件数を返却します。
取得に失敗した場合は(-1)が返却されます。
パラメータ
verifyDate : Date
検証日付
返却値
Number
Number 削除件数