\apex\app\msg\objectswebsocket_message

A web socket message interface class.

Summary

Methods
Properties
Constants
__construct()
get_ajax()
get_recipients()
get_area()
get_uri()
get_json()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$ajax
$recipients
$area
$uri
N/A

Properties

$ajax

$ajax :

Type

$recipients

$recipients :

Type

$area

$area :

Type

$uri

$uri :

Type

Methods

__construct()

__construct(\apex\app\web\ajax  $ajax,array  $recipients = array(),string  $area = '',string  $uri = '')

Define a new web socket message.

Parameters

\apex\app\web\ajax $ajax

The Ajax object that contains actions to perform in web browser.

array $recipients

List of individual recipients to send message to.

string $area

The area to dispatch message to.

string $uri

The URI to dispatch message to.

get_ajax()

get_ajax()

Get the AJAX actions / results

get_recipients()

get_recipients(): array

Get recipients

@return array The list of recipients

Returns

array —

The list of recipients

get_area()

get_area(): string

Get the area

@return string The area to send WS message to

Returns

string —

The area to send WS message to

get_uri()

get_uri(): string

Get the URI

@return string $uri The URI to send WS message to

Returns

string —

$uri The URI to send WS message to

get_json()

get_json(): string

Get JSON of the message. This is what is sent to the web socket server.

@return string JSON encoded string to send to WS server

Returns

string —

JSON encoded string to send to WS server