Guides and Sample Code

Developer

Playground Book Format Reference

On This Page

PlaygroundLiveViewMessageHandler Protocol
PlaygroundLiveViewMessageHandlerプロトコル

A type that supports receiving asynchronous messages from a playground page.
ある型、それはプレイグラウンドページからの非同期のメッセージの受け取りをサポートします。

Overview
概要

This protocol enables a live view to receive messages from a playground page. All of the methods of this protocol are optional.
このプロトコルは、ライブビューにプレイグラウンドページからメッセージを受け取ることを可能にします。このプロトコルのメソッドのすべては、オプショナルです。

Instance Methods
インスタンスメソッド

liveViewMessageConnectionOpened()

Informs the handler that it has connected to a remote object.
ハンドラにそれがリモートオブジェクトに接続されたことを告知します。

Declaration
宣言

  1. func liveViewMessageConnectionOpened()

liveViewMessageConnectionClosed()

Informs the handler that the connection between the proxy and the remote object was closed.
ハンドラにプロキシとリモートオブジェクトの間の接続が閉じられてしまったことを告知します。

Declaration
宣言

  1. func liveViewMessageConnectionClosed()

receive(_:)

Allows the handler to receive a live view message from a remote object .
ハンドラにライブビューメッセージをリモートオブジェクトから受け取らせます。

Declaration
宣言

  1. func receive(_ message: PlaygroundValue)

Parameters
パラメータ

Discussion
解説

The following example receives a dictionary with a command from a remote object. Line 2 checks if the message argument is a dictionary and line 3 gets the command name. The rest of the method parses the command and takes appropriate action.
以下の例は、リモートオブジェクトからのコマンドを持つディクショナリを受け取ります。行2は、message引数がディクショナリかどうか調べます、そして行3はコマンド名を取得します。メソッドの残りは、コマンドを構文解析して適切なアクションを起こします。

  1. func receive(_ message: PlaygroundValue) {
  2.    guard case let .dictionary(dict) = message else { return }
  3.    guard case let .string(commandName)? = dict["command"] else { return }
  4.    // do something with commandName which contains the value stored in "command" key
  5.    …
  6. }

send(_:)

Allows the handler to send a message to a remote object. This method cannot be overridden.
メッセージをリモートオブジェクトに送ることをハンドラに可能にします。このメソッドはオーバーライドされることができません。

Declaration
宣言

  1. func send(_ message: PlaygroundValue)

Parameters
パラメータ

Discussion
解説

Calling this method requires an open connection to a remote object.
このメソッドの呼び出しは、リモートオブジェクトへの開いた接続が必要です。