Ring Daemon 16.0.0
Loading...
Searching...
No Matches
jami::WebViewServicesManager Class Reference

This class provides the interface between loaded WebViewHandlers and client webviews. More...

#include <webviewservicesmanager.h>

Collaboration diagram for jami::WebViewServicesManager:
Collaboration graph

Public Member Functions

 NON_COPYABLE (WebViewServicesManager)
 
std::string sendWebViewAttach (const std::string &pluginId, const std::string &accountId, const std::string &webViewId, const std::string &action)
 Transmits an attach event from the client's webview to the plugin.
 
void sendWebViewDetach (const std::string &pluginId, const std::string &webViewId)
 Transmits a detach event from the client's webview to the plugin.
 
void sendWebViewMessage (const std::string &pluginId, const std::string &webViewId, const std::string &messageId, const std::string &payload)
 Transmits a message from the client's webview to the plugin.
 
 WebViewServicesManager (PluginManager &pluginManager)
 Registers the WebViewHandler services with the PluginManager, allows for loading/unloading, and interaction with client webviews.
 

Detailed Description

This class provides the interface between loaded WebViewHandlers and client webviews.

Definition at line 41 of file webviewservicesmanager.h.

Constructor & Destructor Documentation

◆ WebViewServicesManager()

jami::WebViewServicesManager::WebViewServicesManager ( PluginManager pluginManager)

Registers the WebViewHandler services with the PluginManager, allows for loading/unloading, and interaction with client webviews.

Parameters
pluginManager

Definition at line 33 of file webviewservicesmanager.cpp.

References jami::emitSignal().

Here is the call graph for this function:

Member Function Documentation

◆ NON_COPYABLE()

jami::WebViewServicesManager::NON_COPYABLE ( WebViewServicesManager  )

◆ sendWebViewAttach()

std::string jami::WebViewServicesManager::sendWebViewAttach ( const std::string &  pluginId,
const std::string &  accountId,
const std::string &  webViewId,
const std::string &  action 
)

Transmits an attach event from the client's webview to the plugin.

Parameters
pluginId
accountId
webViewId
actionThe reason why the webview was created
Returns
a relative path to an HTML file inside the datapath

Definition at line 139 of file webviewservicesmanager.cpp.

References jami::emitSignal().

Here is the call graph for this function:

◆ sendWebViewDetach()

void jami::WebViewServicesManager::sendWebViewDetach ( const std::string &  pluginId,
const std::string &  webViewId 
)

Transmits a detach event from the client's webview to the plugin.

Parameters
pluginId
webViewId

Definition at line 151 of file webviewservicesmanager.cpp.

References jami::emitSignal().

Here is the call graph for this function:

◆ sendWebViewMessage()

void jami::WebViewServicesManager::sendWebViewMessage ( const std::string &  pluginId,
const std::string &  webViewId,
const std::string &  messageId,
const std::string &  payload 
)

Transmits a message from the client's webview to the plugin.

Parameters
pluginId
webViewId
messageId
payloadThe message itself

Definition at line 128 of file webviewservicesmanager.cpp.

References jami::emitSignal().

Here is the call graph for this function:

The documentation for this class was generated from the following files: