WikiSysop at 13:44, February 22, 2023

2023-02-22T13:44:28Z

Jumunn: Published

2022-03-02T13:56:01Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Messenger namespace
|Context=Learn about the Messenger namespace methods in the Service Client API.
|ComingSoon=No
|Role=Developer
|Section={{Section
|sectionHeading=Methods
|anchor=methods
|alignment=Vertical
|structuredtext=The Messenger namespace includes the following methods:

*{{Link-SomewhereInThisManual|topic=MessengerNamespace|anchor=broadcastMessage|display text=broadcastMessage}}

===broadcastMessage===
{{{!}}
!Signature
{{!}}<static> broadcastMessage(''channel'', ''message'', ''succeeded'', ''failed'')
{{!}}-
!Description
{{!}}Send a message to other web applications that use the Service Client API and have subscribed to the specified channel.
{{!}}-
!Parameters
{{!}}
{{{!}}
!Name
!Type
!Description
{{!}}-
{{!}}channel
{{!}}string
{{!}}The channel to send the message on.
{{!}}-
{{!}}message
{{!}}object
{{!}}The message (any JSON object) to broadcast on the channel.
{{!}}-
{{!}}succeeded
{{!}}string
{{!}}The callback function to use if the operation succeeded.
{{!}}-
{{!}}failed
{{!}}string
{{!}}The callback function to use if the operation failed.
{{!}}}
{{!}}}

====Samples====
<syntaxhighlight lang="javascript">
// Add a new message broadcaster:
genesys.wwe.service.messenger.broadcastMessage("my-channel", { foo: "A foo text.", bar: 1234 }, succeeded, failed)
// The operation "broadcastMessage" from the service "messenger" takes a channel name and any JSON-compliant object.

// In order to receive this message, you must "subscribe" to "my-channel":
genesys.wwe.service.subscribe([ "messenger:my-channel" ], function(message) { console.log("message: " + message.data); }, this);
// It is possible to subscribe to several channels:
genesys.wwe.service.subscribe([ "messenger:my-channel", "messenger:my-channel2" ], function(message) {
console.log("message: " + message.data + ", channel: " + message.event);
}, this);
</syntaxhighlight>
When a message is broadcast to your channel, you receive an event called <code>messenger:<channel></code> with the message in the <code>data</code> attribute. For example, here's the event for the broadcast in the sample above:<syntaxhighlight lang="json">
{
"event": "messenger:my-channel",
"data": {
"foo": "A foo text.",
"bar": 1234
},
"userAgent": "WWE Server",
"protocolVersion": 2
}
</syntaxhighlight>
|Status=No
}}
}}

@@ Line 37: / Line 37: @@
 {{!}}-
 {{!}}succeeded
-{{!}}string
+{{!}}function
-{{!}}The callback function to use if the operation succeeded.
+{{!}}A function called when the operation succeeds.
 {{!}}-
 {{!}}failed
-{{!}}string
+{{!}}function
-{{!}}The callback function to use if the operation failed.
+{{!}}A function called when the operation fails.
 {{!}}}
 {{!}}}

PEC-Developer/Current/SCAPI/MessengerNamespace - Revision history

WikiSysop at 13:44, February 22, 2023

Jumunn: Published