package Torello.Browser.BrowserAPI;

// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
// Java-HTML Imports
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

import Torello.Browser.*;
import Torello.Browser.helper.*;
import Torello.Browser.JavaScriptAPI.*;
import Torello.JSON.*;

import Torello.Java.ReadOnly.ReadOnlyList;
import Torello.Java.ReadOnly.ReadOnlyArrayList;

import Torello.JavaDoc.Annotations.StaticFunctional;
import Torello.JavaDoc.Annotations.JDHeaderBackgroundImg;

import Torello.Browser.BrowserAPI.NestedHelpers.Commands.DeviceAccess$$Commands;


// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
// JDK Imports
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

import javax.json.JsonObject;
import javax.json.JsonValue;

/**
 * <SPAN CLASS=COPIEDJDK><B><CODE>[No Description Provided by Google]</CODE></B></SPAN>
 * <EMBED CLASS='external-html' DATA-FILE-ID=CDP.CODE_GEN_NOTE>
 */
@StaticFunctional@JDHeaderBackgroundImg(EmbedTagFileID="CDP.WOOD_PLANK_NOTE")
public class DeviceAccess
{
    // No Pubic Constructors
    private DeviceAccess() { }


    // ********************************************************************************************
    // ********************************************************************************************
    // Eliminated Types
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * A device id.

     * <EMBED CLASS='external-html' DATA-CTAS='String' DATA-FILE-ID=CDP.EliminatedType
     *     DATA-NAME=DeviceId>
     */
    public static final String DeviceId =
        "DeviceId has been eliminated.\n" +
        "It was replaced with the standard Java-Type: String";

    /**
     * Device request id.

     * <EMBED CLASS='external-html' DATA-CTAS='String' DATA-FILE-ID=CDP.EliminatedType
     *     DATA-NAME=RequestId>
     */
    public static final String RequestId =
        "RequestId has been eliminated.\n" +
        "It was replaced with the standard Java-Type: String";



    // ********************************************************************************************
    // ********************************************************************************************
    // Basic Types
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Device information displayed in a user prompt to select a device.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=DeviceAccess DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class PromptDevice
        extends BaseType<PromptDevice>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<DeviceAccess.PromptDevice> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Types.
                DeviceAccess$$PromptDevice$$.singleton;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String id;

        /** Display name as it appears in a device request user prompt. */
        public final String name;

        /** Constructor.  Please review this class' fields for documentation. */
        public PromptDevice(ReadOnlyList<Boolean> isPresent, String id, String name)
        {
            super(singleton, Domains.DeviceAccess, "PromptDevice", 2);

            this.id     = id;
            this.name   = name;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 2, "DeviceAccess.PromptDevice");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static PromptDevice fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<PromptDevice> descriptor()
        { return singleton.descriptor(); }
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Event Types
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * A device request opened a user prompt to select a device. Respond with the
     * selectPrompt or cancelPrompt command.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=DeviceAccess DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
    public static class deviceRequestPrompted
        extends BrowserEvent<deviceRequestPrompted>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<DeviceAccess.deviceRequestPrompted> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Events.
                DeviceAccess$$deviceRequestPrompted$$.singleton;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String id;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final DeviceAccess.PromptDevice[] devices;

        /** Constructor.  Please review this class' fields for documentation. */
        public deviceRequestPrompted
            (ReadOnlyList<Boolean> isPresent, String id, PromptDevice[] devices)
        {
            super(singleton, Domains.DeviceAccess, "deviceRequestPrompted", 2);

            this.id         = id;
            this.devices    = devices;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 2, "DeviceAccess.deviceRequestPrompted");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static deviceRequestPrompted fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<deviceRequestPrompted> descriptor()
        { return singleton.descriptor(); }
    }




    // ********************************************************************************************
    // ********************************************************************************************
    // Commands
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Cancel a prompt in response to a DeviceAccess.deviceRequestPrompted event.
     * 
     * @param id -
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> cancelPrompt(String id)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get
            (CDPTypes.STRING, "id", false, "DeviceAccess.cancelPrompt", id);

        return Script.NO_RET(Domains.DeviceAccess, "cancelPrompt", requestJSON);
    }

    /**
     * Disable events in this domain.
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> disable()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"DeviceAccess.disable\"}";

        return Script.NO_RET(Domains.DeviceAccess, "disable", requestJSON);
    }

    /**
     * Enable events in this domain.
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> enable()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"DeviceAccess.enable\"}";

        return Script.NO_RET(Domains.DeviceAccess, "enable", requestJSON);
    }

    /**
     * Select a device in response to a DeviceAccess.deviceRequestPrompted event.
     * 
     * @param id -
     * 
     * @param deviceId -
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> selectPrompt(String id, String deviceId)
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            DeviceAccess$$Commands.selectPrompt$$, "DeviceAccess.selectPrompt",
            id, deviceId
        );

        return Script.NO_RET(Domains.DeviceAccess, "selectPrompt", requestJSON);
    }


}