public abstract class

ScriptHandler

extends java.lang.Object

 java.lang.Object

↳androidx.webkit.ScriptHandler

Subclasses:

ScriptHandlerImpl

Gradle dependencies

compile group: 'androidx.webkit', name: 'webkit', version: '1.5.0-alpha01'

  • groupId: androidx.webkit
  • artifactId: webkit
  • version: 1.5.0-alpha01

Artifact androidx.webkit:webkit:1.5.0-alpha01 it located at Google repository (https://maven.google.com/)

Androidx artifact mapping:

androidx.webkit:webkit com.android.support:webkit

Overview

This class represents the return result from WebViewCompat. Call ScriptHandler.remove() when the corresponding JavaScript script should be removed.

Summary

Constructors
publicScriptHandler()

This class cannot be created by applications.

Methods
public abstract voidremove()

Removes the corresponding script, it will take effect from next page load.

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

public ScriptHandler()

This class cannot be created by applications.

Methods

public abstract void remove()

Removes the corresponding script, it will take effect from next page load.

Source

/*
 * Copyright 2020 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package androidx.webkit;

import androidx.annotation.RequiresFeature;
import androidx.annotation.RestrictTo;

/**
 * This class represents the return result from {@link WebViewCompat#addDocumentStartJavaScript(
 * android.webkit.WebView, String, Set)}. Call {@link ScriptHandler#remove()} when the
 * corresponding JavaScript script should be removed.
 *
 * @see WebViewCompat#addDocumentStartJavaScript(android.webkit.WebView, String, Set)
 *
 * TODO(swestphal): unhide when ready.
 * @hide
 */
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
public abstract class ScriptHandler {
    /**
     * Removes the corresponding script, it will take effect from next page load.
     */
    @RequiresFeature(name = WebViewFeature.DOCUMENT_START_SCRIPT,
            enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
    public abstract void remove();

    /**
     * This class cannot be created by applications.
     * @hide
     */
    @RestrictTo(RestrictTo.Scope.LIBRARY)
    public ScriptHandler() {}
}