RStudio Launcher Plugin SDK  1.1.3
A software development kit for creating plugins that work the the RStudio Launcher.
Public Member Functions | Protected Member Functions | List of all members
rstudio::launcher_plugins::api::AbstractPluginApi Class Referenceabstract

Base class for the Launcher Plugin API. More...

#include <AbstractPluginApi.hpp>

Inheritance diagram for rstudio::launcher_plugins::api::AbstractPluginApi:
rstudio::launcher_plugins::Noncopyable rstudio::launcher_plugins::local::LocalPluginApi rstudio::launcher_plugins::quickstart::QuickStartPluginApi

Public Member Functions

virtual ~AbstractPluginApi ()=default
 Virtual destructor.
Error initialize ()
 This method initializes the abstract plugin API. More...
- Public Member Functions inherited from rstudio::launcher_plugins::Noncopyable
 Noncopyable ()=default
 Default constructor.
 Noncopyable (const Noncopyable &)=delete
 Deleted copy constructor.
Noncopyableoperator= (const Noncopyable &)=delete
 Deleted assignment operator.

Protected Member Functions

 AbstractPluginApi (std::shared_ptr< comms::AbstractLauncherCommunicator > in_launcherCommunicator)
 Constructor. More...

Detailed Description

Base class for the Launcher Plugin API.

Constructor & Destructor Documentation

◆ AbstractPluginApi()

rstudio::launcher_plugins::api::AbstractPluginApi::AbstractPluginApi ( std::shared_ptr< comms::AbstractLauncherCommunicator in_launcherCommunicator)


in_launcherCommunicatorThe communicator to use for sending and receiving messages from the RStudio Launcher.

Member Function Documentation

◆ initialize()

Error rstudio::launcher_plugins::api::AbstractPluginApi::initialize ( )

This method initializes the abstract plugin API.

Success if the abstract plugin API was successfully initialized; Error otherwise.

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