GAM のメニューの取得、作成、更新には、次の API を使用します。

GAMApplication API

メニューを取得するためのメソッド:

メニューを更新するためのメソッド:

メニューオプションを更新するためのメソッド:

メニューオプションを取得するためのメソッド:

ユーザーメニューを取得するためのメソッド:

注:
前述の例では、次のいずれかの方法で &GAMApplication をインスタンス化する必要があります。

• &GAMApplication.Load(&GAMApplicationId)

• &GAMApplication = GAMRepository.GetApplicationByGUID(&GAMApplicationGUID,&Errors) //&Errors は GAMError コレクション

GAMRepository API

例

I. 動的プロパティを使用したメニューの作成

メニューの動的プロパティを使用して、各メニューオプションに使用するクラスやアイコンを定義できます。

&GAMApplication.Load(1)
&GUID.FromString('d0bfd659-7912-4fb8-9751-4a27546fb400')
&ApplicationMenu.GUID            = &GUID
&ApplicationMenu.Name           = !"Security"
&ApplicationMenu.Description   = !"Security"
&isOK = &GAMApplication.AddMenu(&ApplicationMenu, &Errors)
If &isOK
    Commit
    &MenuId = &ApplicationMenu.Id
    //メニューオプションの定義
    &ApplicationMenuOption = new()
    &GUID.FromString('dcdee429-45ae-4bd6-bf71-16e4cc90f724')
    &Name = !"Users"
    &Dsc    = !"Users"
    &Type  = GAMMenuOptionType.Simple
    &MenusId = 0
    //メニューオプションの動的プロパティの定義   
    &GAMProperty           = new()
    &GAMProperty.Id        = !"IconClassUsers"
    &GAMProperty.Value     = !"IconClassUsers"
    &ApplicationMenuOption.Properties.Add(&GAMProperty)
       
    &GAMApplicationPermission = &GAMApplication.GetPermissionByName(!"gamexamplewwusers_Execute",&Errors)
    &RelResId = &GAMApplicationPermission.GUID
    &Resource = !"gamexamplewwusers"
    Do 'Load_ApplicationMenuOption'  
    &isOK = &GAMApplication.AddMenuOption(&MenuId, &ApplicationMenuOption, &Errors)

endif

Sub 'Load_ApplicationMenuOption'
    &ApplicationMenuOption.GUID                            = &GUID
    &ApplicationMenuOption.Name                            = &Name
    &ApplicationMenuOption.Description                     = &Dsc
    &ApplicationMenuOption.Type                            = &Type
    &ApplicationMenuOption.SubMenuId                       = &MenusId
    &ApplicationMenuOption.PermissionResourceGUID          = &RelResId
    &ApplicationMenuOption.Resource                        = &Resource
    &ApplicationMenuOption.ResourceParameters              = &ResourceParameters
EndSub

II. 次のコードでは、指定したメニューのメニューオプションを取得します:

//&AppMenuOption は GAMApplicationMenuOption データタイプ
//&Application は GAMApplication
//&Filter は GAMApplicationMenuOptionFilter
//&Errors は GAMError コレクション

&Application.Load(&ApplicationId)
For &AppMenuOption in &Application.GetMenuOptions(&MenuId, &Filter, &Errors)
       
        &Id            = &AppMenuOption.Id
        &Name          = &AppMenuOption.Name
        &Dsc           = &AppMenuOption.Description    
        &Type          = &AppMenuOption.Type
        &Order         = &AppMenuOption.Order
       
    EndFor    

III. 追加パラメーターを使用した動的プロパティのロード

メニューオプションの動的プロパティをロードするには、GAMMenuAdditionalParameters (GetUserMenuByGUID メソッドのパラメーター) の LoadProperties メソッドを使用します。

    &GUID = 'd0bfd659-7912-4fb8-9751-4a27546fb400'
    &GAMApplication.Load(1)
    
    &GAMMenuAdditionalParameters.LoadProperties    = TRUE
    &GAMMenuAdditionalParameters.Levels = &levels
        
    &GAMMenuOptionList = &GAMApplication.GetUserMenuByGUID(&GUID,&GAMMenuAdditionalParameters,&Errors)
    if &Errors.Count <> 0
        msg(&Errors.Item(1).Code + " " + &Errors.item(1).Message)
    endif

IV. メニューオプションの絶対 URL または相対 URL の使用

各メニューオプション用に返される URL は、メニューが定義されている GAM アプリケーションの [ Use absolute URL by environment ] プロパティの設定に応じて、絶対 URL か相対 URL かが決まります。

この値は、GAMMenuAdditionalParameters (ユーザーメニューの取得に使用するメソッドのパラメーター) の [ ReturnAbsoluteUrlByEnvironment ] プロパティを使用して上書きできます。
[ ReturnAbsoluteUrlByEnvironment ] プロパティには次の値を指定できます。
サンプルコード:
&GAMApplication.Load(1)
&GAMMenuAdditionalParameters.ReturnAbsoluteUrlByEnvironment = TRUE
&GAMMenuOptionList = &GAMApplication.GetUserMenuByGUID(&GUID,&GAMMenuAdditionalParameters,&Errors)

V. 権限なしでオプションをロード

ユーザーのアクセス許可に関係なく、すべてのメニューを取得できると便利な場合があります。
次のプロパティは、ユーザーメニューの取得に使用するメソッドのパラメーターである GAMMenuAdditionalParameters オブジェクトに属しています。

サンプルコード:

&GAMApplication.Load(1)
&GAMMenuAdditionalParameters.ReturnOptionsWithoutPermission = TRUE
&GAMMenuAdditionalParameters.URLOptionsWithoutPermissions   = &link
&GAMMenuOptionList = &GAMApplication.GetUserMenuByGUID(&GUID,&GAMMenuAdditionalParameters,&Errors)

注:

これらの API は、GeneXus と合わせて配布される GAM Examples に含まれています。これらは、GAM のアクティベーションプロセス中に統合されます。特に次のオブジェクトは、API の使用方法について理解するのに役立ちます。

• GAMExampleAppMenuEntry
• GAMExampleAppMenuOptionEntry
• GAMExampleWWAppMenus
• GAMExampleWWAppMenuOptions