vscode-kubernetes-tools-api/js/clusterprovider/v1.js

Documents and encapsulates the API for the Kubernetes extension for Visual Studio Code

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
var ClusterProviderV1;
(function (ClusterProviderV1) {
    /**
     * If a cluster provider UI page gathers user input using a form, you must use this
     * name as the id property of the form.
     */
    ClusterProviderV1.WIZARD_FORM_NAME = "form";
    /**
     * The name of the function invoked by NEXT_PAGE to navigate to the next page of the cluster
     * provider UI. This is provided in case you need to call the function in a custom way;
     * for most situations, use the NEXT_PAGE code fragment.
     */
    ClusterProviderV1.NEXT_PAGE_FN_NAME = "onNext";
    /**
     * If a cluster provider UI page provides a way for the user to navigate to the next page,
     * it must call this code fragment from its triggering event.
     * @example
     * `<form id='${k8s.clusterprovider.WIZARD_FORM_NAME}'>
          <input type='hidden' name='${k8s.clusterprovider.CLUSTER_TYPE_KEY}' value='mytype' />
          <button onclick='${k8s.clusterprovider.NEXT_PAGE}'>Next &gt;</button>
      </form>`
     */
    ClusterProviderV1.NEXT_PAGE = "onNext();";
    /**
     * If a cluster provider UI page provides a way for the user to navigatge to the next page,
     * it must submit a form containing at least this key with a value of the cluster type's 'id'
     * property.
     * @example
     * `<form id='${k8s.clusterprovider.WIZARD_FORM_NAME}'>
     *     <input type='hidden' name='${k8s.clusterprovider.CLUSTER_TYPE_KEY}' value='mytype' />
     *     <button onclick='${k8s.clusterprovider.NEXT_PAGE}'>Next &gt;</button>
     * </form>`
     */
    ClusterProviderV1.CLUSTER_TYPE_KEY = 'clusterType';
    /**
     * When a wizard-provided step calls your cluster provider's 'next' method, the 'message'
     * parameter will include this key to identify which step sent the message.  Currently
     * the only value the wizard will send is SELECT_CLUSTER_TYPE_STEP_ID.
     */
    ClusterProviderV1.SENDING_STEP_KEY = 'sendingStep';
    /**
     * Sent as the message[SENDING_STEP_KEY] value when the wizard 'select cluster type' screen
     * invokes your cluster provider.
     */
    ClusterProviderV1.SELECT_CLUSTER_TYPE_STEP_ID = 'selectClusterType';
})(ClusterProviderV1 = exports.ClusterProviderV1 || (exports.ClusterProviderV1 = {}));
//# sourceMappingURL=v1.js.map