third_party/blink/public/web/web_dom_message_event.h

/*
 * Copyright (C) 2011 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef THIRD_PARTY_BLINK_PUBLIC_WEB_WEB_DOM_MESSAGE_EVENT_H_
#define THIRD_PARTY_BLINK_PUBLIC_WEB_WEB_DOM_MESSAGE_EVENT_H_

#include "base/optional.h"
#include "base/unguessable_token.h"
#include "third_party/blink/public/common/messaging/message_port_channel.h"
#include "third_party/blink/public/common/messaging/transferable_message.h"
#include "third_party/blink/public/platform/web_string.h"
#include "third_party/blink/public/web/web_document.h"
#include "third_party/blink/public/web/web_dom_event.h"
#include "third_party/blink/public/web/web_serialized_script_value.h"

#if INSIDE_BLINK
#include "third_party/blink/renderer/core/events/message_event.h"  // nogncheck
#endif

namespace blink {

class WebFrame;

// An interface for posting message events to the target frame. The message
// events are used for communication between documents and described here:
// http://www.w3.org/TR/2012/WD-webmessaging-20120313/#terminology
class WebDOMMessageEvent : public WebDOMEvent {
 public:
  BLINK_EXPORT WebDOMMessageEvent(
      const WebSerializedScriptValue& message_data,
      const WebString& origin = WebString(),
      const WebFrame* source_frame = nullptr,
      const WebDocument& target_document = WebDocument(),
      WebVector<MessagePortChannel> ports = WebVector<MessagePortChannel>());
  BLINK_EXPORT WebDOMMessageEvent(
      TransferableMessage,
      const WebString& origin = WebString(),
      const WebFrame* source_frame = nullptr,
      const WebDocument& target_document = WebDocument());
  WebDOMMessageEvent() = default;

  BLINK_EXPORT WebString Origin() const;

  base::Optional<base::UnguessableToken> locked_agent_cluster_id() const {
    return locked_agent_cluster_id_;
  }

  // The |encoded_message| in the returned message is only valid as long as this
  // WebDOMMessageEvent is still valid, unless EnsureDataIsOwned is called on
  // the returned message.
  BLINK_EXPORT TransferableMessage AsMessage();

#if INSIDE_BLINK
  explicit WebDOMMessageEvent(MessageEvent* e) : WebDOMEvent(e) {}
#endif

 private:
  base::Optional<base::UnguessableToken> locked_agent_cluster_id_;
};

}  // namespace blink

#endif