public class

WebMessageCompat

extends java.lang.Object

 java.lang.Object

↳androidx.webkit.WebMessageCompat

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

The Java representation of the HTML5 PostMessage event. See https://html.spec.whatwg.org/multipage/comms.html#the-messageevent-interfaces for definition of a MessageEvent in HTML5.

Summary

Constructors
publicWebMessageCompat(java.lang.String data)

Creates a WebMessage.

publicWebMessageCompat(java.lang.String data, WebMessagePortCompat ports[])

Creates a WebMessage.

Methods
public java.lang.StringgetData()

Returns the data of the message.

public WebMessagePortCompatgetPorts()

Returns the ports that are sent with the message, or null if no port is sent.

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

Constructors

public WebMessageCompat(java.lang.String data)

Creates a WebMessage.

Parameters:

data: the data of the message.

public WebMessageCompat(java.lang.String data, WebMessagePortCompat ports[])

Creates a WebMessage.

Parameters:

data: the data of the message.
ports: the ports that are sent with the message.

Methods

public java.lang.String getData()

Returns the data of the message.

public WebMessagePortCompat getPorts()

Returns the ports that are sent with the message, or null if no port is sent.

Source

/*
 * Copyright 2018 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.Nullable;

/**
 * The Java representation of the HTML5 PostMessage event. See
 * https://html.spec.whatwg.org/multipage/comms.html#the-messageevent-interfaces
 * for definition of a MessageEvent in HTML5.
 */
public class WebMessageCompat {

    private String mData;
    private WebMessagePortCompat[] mPorts;

    /**
     * Creates a WebMessage.
     * @param data  the data of the message.
     */
    public WebMessageCompat(@Nullable String data) {
        mData = data;
    }

    /**
     * Creates a WebMessage.
     * @param data  the data of the message.
     * @param ports  the ports that are sent with the message.
     */
    public WebMessageCompat(@Nullable String data, @Nullable WebMessagePortCompat[] ports) {
        mData = data;
        mPorts = ports;
    }

    /**
     * Returns the data of the message.
     */
    public @Nullable String getData() {
        return mData;
    }

    /**
     * Returns the ports that are sent with the message, or {@code null} if no port
     * is sent.
     */
    @Nullable
    public WebMessagePortCompat[] getPorts() {
        return mPorts;
    }
}