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.BackgroundService$$Commands;


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

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

/**
 * <SPAN CLASS=COPIEDJDK><B>Defines events for background web platform features.</B></SPAN>
 * <EMBED CLASS='external-html' DATA-FILE-ID=CDP.CODE_GEN_NOTE>
 */
@StaticFunctional@JDHeaderBackgroundImg(EmbedTagFileID="CDP.WOOD_PLANK_NOTE")
public class BackgroundService
{
    // No Pubic Constructors
    private BackgroundService() { }


    // ********************************************************************************************
    // ********************************************************************************************
    // Enumerated String Constants Lists
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * The Background Service that will be associated with the commands/events.
     * Every Background Service operates independently, but they share the same
     * API.
     * <BR /><BR /><B CLASS=StrEnumType>String-Enumeration Type</B>
     */
    public static final ReadOnlyList<String> ServiceName = new ReadOnlyArrayList<>(
        String.class, 
        "backgroundFetch", "backgroundSync", "notifications", "paymentHandler",
        "periodicBackgroundSync", "pushMessaging"
    );



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


    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=BackgroundService DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class BackgroundServiceEvent
        extends BaseType<BackgroundServiceEvent>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

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

        /** Timestamp of the event (in seconds). */
        public final Number timestamp;

        /** The origin this event belongs to. */
        public final String origin;

        /** The Service Worker ID that initiated the event. */
        public final String serviceWorkerRegistrationId;

        /**
         * The Background Service this event belongs to.
         * <EMBED CLASS='external-html' DATA-D=BackgroundService DATA-C=ServiceName DATA-F=service DATA-FILE-ID=CDP.EL2>
         * @see BaseType#enumStrList(String)
         */
        public final String service;

        /** A description of the event. */
        public final String eventName;

        /** An identifier that groups related events together. */
        public final String instanceId;

        /** A list of event-specific information. */
        public final BackgroundService.EventMetadata[] eventMetadata;

        /** Storage key this event belongs to. */
        public final String storageKey;

        /** Constructor.  Please review this class' fields for documentation. */
        public BackgroundServiceEvent(
                ReadOnlyList<Boolean> isPresent, Number timestamp, String origin,
                String serviceWorkerRegistrationId, String service, String eventName,
                String instanceId, EventMetadata[] eventMetadata, String storageKey
            )
        {
            super(singleton, Domains.BackgroundService, "BackgroundServiceEvent", 8);

            this.timestamp                      = timestamp;
            this.origin                         = origin;
            this.serviceWorkerRegistrationId    = serviceWorkerRegistrationId;
            this.service                        = service;
            this.eventName                      = eventName;
            this.instanceId                     = instanceId;
            this.eventMetadata                  = eventMetadata;
            this.storageKey                     = storageKey;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 8, "BackgroundService.BackgroundServiceEvent");
        }

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

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

    /**
     * A key-value pair for additional event information to pass along.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=BackgroundService DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class EventMetadata
        extends BaseType<EventMetadata>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

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

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

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

        /** Constructor.  Please review this class' fields for documentation. */
        public EventMetadata(ReadOnlyList<Boolean> isPresent, String key, String value)
        {
            super(singleton, Domains.BackgroundService, "EventMetadata", 2);

            this.key    = key;
            this.value  = value;

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

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

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


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


    /**
     * Called with all existing backgroundServiceEvents when enabled, and all new
     * events afterwards if enabled and recording.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=BackgroundService DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
    public static class backgroundServiceEventReceived
        extends BrowserEvent<backgroundServiceEventReceived>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

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

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final BackgroundService.BackgroundServiceEvent backgroundServiceEvent;

        /** Constructor.  Please review this class' fields for documentation. */
        public backgroundServiceEventReceived
            (ReadOnlyList<Boolean> isPresent, BackgroundServiceEvent backgroundServiceEvent)
        {
            super(singleton, Domains.BackgroundService, "backgroundServiceEventReceived", 1);

            this.backgroundServiceEvent = backgroundServiceEvent;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 1, "BackgroundService.backgroundServiceEventReceived");
        }

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

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

    /**
     * Called when the recording state for the service has been updated.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=BackgroundService DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
    public static class recordingStateChanged
        extends BrowserEvent<recordingStateChanged>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

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

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final boolean isRecording;

        /**
         * <CODE>[No Description Provided by Google]</CODE>
         * <EMBED CLASS='external-html' DATA-D=BackgroundService DATA-C=ServiceName DATA-F=service DATA-FILE-ID=CDP.EL2>
         * @see BaseType#enumStrList(String)
         */
        public final String service;

        /** Constructor.  Please review this class' fields for documentation. */
        public recordingStateChanged
            (ReadOnlyList<Boolean> isPresent, boolean isRecording, String service)
        {
            super(singleton, Domains.BackgroundService, "recordingStateChanged", 2);

            this.isRecording    = isRecording;
            this.service        = service;

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

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

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




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


    /**
     * Clears all stored data for the service.
     * 
     * @param service -
     * 
     * @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> clearEvents(String service)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get
            (CDPTypes.STRING, "service", false, "BackgroundService.clearEvents", service);

        return Script.NO_RET(Domains.BackgroundService, "clearEvents", requestJSON);
    }

    /**
     * Set the recording state for the service.
     * 
     * @param shouldRecord -
     * 
     * @param service -
     * 
     * @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> setRecording(boolean shouldRecord, String service)
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            BackgroundService$$Commands.setRecording$$, "BackgroundService.setRecording",
            shouldRecord, service
        );

        return Script.NO_RET(Domains.BackgroundService, "setRecording", requestJSON);
    }

    /**
     * Enables event updates for the service.
     * 
     * @param service -
     * 
     * @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> startObserving(String service)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get
            (CDPTypes.STRING, "service", false, "BackgroundService.startObserving", service);

        return Script.NO_RET(Domains.BackgroundService, "startObserving", requestJSON);
    }

    /**
     * Disables event updates for the service.
     * 
     * @param service -
     * 
     * @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> stopObserving(String service)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get
            (CDPTypes.STRING, "service", false, "BackgroundService.stopObserving", service);

        return Script.NO_RET(Domains.BackgroundService, "stopObserving", requestJSON);
    }


}