OpenFin Workspace Platform API
    Preparing search index...

    Interface StoreCustomButtonActionPayload

    The shape of the payload that is sent by a store app primary button or secondary button click to a platform custom action handler

    interface StoreCustomButtonActionPayload {
        appId: string;
        callerType: StoreCustomButton;
        customData: any;
        primaryButton: StoreButtonConfig;
        secondaryButtons: StoreButtonConfig[];
        sourceButtonConfig: StoreButtonConfig;
        storeFrontProviderId: string;
        windowIdentity: Identity_4;
        x: number;
        y: number;
    }

    Hierarchy

    Index
    appId callerType customData primaryButton secondaryButtons sourceButtonConfig storeFrontProviderId windowIdentity x y
    appId: string

    Invoking application id.

    callerType: StoreCustomButton
    customData: any

    Any data necessary for the functioning of specified custom action

    primaryButton: StoreButtonConfig
    secondaryButtons: StoreButtonConfig[]
    sourceButtonConfig: StoreButtonConfig
    storeFrontProviderId: string
    windowIdentity: Identity_4

    Identity for the current window.

    x: number

    Screen x-coordinate where custom button should be shown.

    y: number

    Screen y-coordinate where custom button should be shown.

    Settings

    On This Page
    Properties