Search Results for

    Show / Hide Table of Contents

    Method CreateCustomButton

    CreateCustomButton(String, CustomButtonContract)

    Create custom button

    Declaration
    CustomButtonContract CreateCustomButton(string connectionId, CustomButtonContract customButton)
    Parameters
    Type Name Description
    System.String connectionId

    The connection id to identify your connection. See also ConnectionId

    CustomButtonContract customButton

    Custom button to create.

    Returns
    Type Description
    CustomButtonContract
    Remarks

    Set option "PreventCustomButtonCommands" to true in ConfigRdbNew.xml to disable commands for custom buttons. You cannot create custom buttons when your command is set.

    Examples

    POST http://YourServerName/InfoShare/Json/Common/CreateCustomButton

    Example for create custom button

    {
        "connectionId": "c748a0e8-b2b3-4d59-83ff-024f77fed807",
        "customButton": {
            "Command": "winword.exe",
            "MultiselectAllowed": true,
            "Name": {
                "Values": [
                    {
                        "Culture": "de",
                        "Text": "In Word öffnen"
                    },
                    {
                        "Culture": "en",
                        "Text": "Open in Word"
                    },
                    {
                        "Culture": "fr",
                        "Text": "Ouvrir dans Word"
                    },
                    {
                        "Culture": "it",
                        "Text": "Apri in Word"
                    }
                ]
            },
            "ObjectTypeFilter": [
                "file",
                "folder"
            ],
            "ParentButtonId": "10009999-4586-510c-3843-2d123c5acec7",
            "PopUpSettingsContract": {
                "Active": true,
                "Height": "10",
                "Width": "11"
            },
            "QueryFilter": [
                {
                    "ComparisonEnum": "Equals",
                    "GlobalValues": [
                        {
                             "Values": [
                                {
                                    "Culture": "de",
                                    "Text": "Dokument"
                                },
                                {
                                    "Culture": "en",
                                    "Text": "document"
                                },
                                {
                                     "Culture": "fr",
                                    "Text": "document"
                                }
                            ]
                        } 
                    ],
                    "PlaceHolder": "0",
                    "PropertyTypeId": "10008888-4586-510c-3843-2d123c5acec7",
                    "RelationEnum": "And",
                    "Values": [
                        "document"
                    ]
                },
                {
                    "ComparisonEnum": "Contains",
                    "GlobalValues": [],
                    "PlaceHolder": "0",
                    "PropertyTypeId": "10007045-4586-510c-3843-2d123c5acec7",
                    "RelationEnum": "And",
                    "Values": [
                        "Ablage",
                        "Umlage"
                    ]
                }
            ],
            "Target": "_blank",
            "TimeOut": 1000,
            "URL": "http://localhost/MobileWebClient/OpenWord",
            "UserRoleFilter": [
                "Admins",
                "Accounting"
            ],
            "WaitForResponse": true,
            "RefreshSearchAfterExecution": true,
            "SortOrder": 0,
            "AdaptiveCard": "adaptiveCard",
            "IconName": "iconName",
            "Options": "OptionsPlaceHolder/json"
        }
    }

    Response:

    {
        "CreateCustomButtonResult": {
            "Command": "winword.exe",
            "Id": "b1c3d536-a7f9-ea11-a0d3-00155d109000",
            "MultiselectAllowed": true,
            "Name": {
                "Values": [
                    {
                        "Culture": "de",
                        "Text": "In Word öffnen"
                    },
                    {
                        "Culture": "en",
                        "Text": "Open in Word"
                    },
                    {
                        "Culture": "fr",
                        "Text": "Ouvrir dans Word"
                    },
                    {
                        "Culture": "it",
                        "Text": "Apri in Word"
                    } 
                ]
            },
            "ObjectTypeFilter": [
                "file",
                "folder"
            ],
            "ParentButtonId": "10009999-4586-510c-3843-2d123c5acec7",
            "PopUpSettingsContract": {
                "Active": true,
                "Height": "10",
                "Width": "11"
            },
            "QueryFilter": [
                {
                    "ComparisonEnum": "Equals",
                    "GlobalValues": [
                        {
                            "Values": [
                                {
                                    "Culture": "de",
                                     "Text": "Dokument"
                                },
                                {
                                    "Culture": "en",
                                    "Text": "document"
                                },
                                {
                                    "Culture": "fr",
                                    "Text": "document"
                                }
                            ]
                        } 
                    ], 
                    "Id": null,
                    "PlaceHolder": "0",
                    "PropertyTypeId": "10008888-4586-510c-3843-2d123c5acec7",
                    "RelationEnum": "And",
                    "Values": [
                        "document"
                    ]
                },
                {
                    "ComparisonEnum": "Contains",
                    "GlobalValues": [],
                    "Id": null,
                    "PlaceHolder": "0",
                    "PropertyTypeId": "10007045-4586-510c-3843-2d123c5acec7",
                    "RelationEnum": "And",
                    "Values": [
                        "Ablage",
                        "Umlage"
                    ]
                }
            ],
            "Target": "_blank",
            "Timeout": 1000,
            "URL": "http://localhost/MobileWebClient/OpenWord",
            "UserRoleFilter": [
                "Admins",
                "Accounting"
            ],
            "WaitForResponse": true,
            "RefreshSearchAfterExecution": true,
            "SortOrder": 0,
            "AdaptiveCard": "adaptiveCard",
            "IconName": "iconName",
            "Options": "OptionsPlaceHolder/json"
        }
    }
    Exceptions
    Type Condition
    ServiceException

    The connection id {connectionId} isn't valid or has expired (10008)

    ServiceException

    Verification code is needed: Verification code not yet verified (10152)

    ServiceException

    Parent custom button with id "{customButtonParentId}" does not exist (10240)

    ServiceException

    CustomButton commands are not allowed. (10284)

    Back to top Copyright © Kendox