GlobalConfigurationsServices.GetToolbarConfig Method

GlobalConfigurationsServicesGetToolbarConfig Method

Ingeniux CMS Web Services API

Retrieves the avialable commands for current user to carry out on the user interface toolbar. Unlike Site Tree Menu config, toolbar command are not just page level commands.

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public XHRServiceResponseGeneric<ToolbarButtonInformation[]> GetToolbarConfig()

Public Function GetToolbarConfig As XHRServiceResponseGeneric(Of ToolbarButtonInformation())

public:
virtual XHRServiceResponseGeneric<array<ToolbarButtonInformation^>^>^ GetToolbarConfig() sealed

abstract GetToolbarConfig : unit -> XHRServiceResponseGeneric<ToolbarButtonInformation[]> 
override GetToolbarConfig : unit -> XHRServiceResponseGeneric<ToolbarButtonInformation[]>

Return Value

Type: XHRServiceResponseGenericToolbarButtonInformation
The collection of toolbar command information allowed for current user

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": [{
        "name": "Overview",
        "isDisplayed": true,
        "isSeparator": false
    }, {
        "name": "Save",
        "isDisplayed": true,
        "isSeparator": false
    }, {
        "name": "separator1",
        "isDisplayed": true,
        "isSeparator": true
    }, {
        "name": "CheckOut",
        "isDisplayed": true,
        "isSeparator": false
    }, {
        "name": "Rename",
        "isDisplayed": true,
        "isSeparator": false
    }, {
        "name": "AssignTo",
        "isDisplayed": true,
        "isSeparator": false
    }, {
        "name": "Advance",
        "isDisplayed": true,
        "isSeparator": false
    }, {
        "name": "separator2",
        "isDisplayed": true,
        "isSeparator": true
    }, {
        "name": "SpellCheck",
        "isDisplayed": true,
        "isSeparator": false
    }, {
        "name": "separator3",
        "isDisplayed": true,
        "isSeparator": true
    }, {
        "name": "Refresh",
        "isDisplayed": true,
        "isSeparator": false
    }, {
        "name": "Preview",
        "isDisplayed": true,
        "isSeparator": false
    }, {
        "name": "Publish",
        "isDisplayed": true,
        "isSeparator": false
    }, {
        "name": "separator4",
        "isDisplayed": true,
        "isSeparator": true
    }, {
        "name": "Assets",
        "isDisplayed": true,
        "isSeparator": false
    }]
}

Reference

GlobalConfigurationsServices Class

IngeniuxCMService Namespace