nx_metadata_sdk  1.0
Metadata SDK
Public Member Functions | Static Public Member Functions | List of all members
nx::sdk::IActionResponse Class Referenceabstract

#include <i_action_response.h>

Inheritance diagram for nx::sdk::IActionResponse:
nx::sdk::Interface< IActionResponse > nx::sdk::IRefCountable nx::sdk::RefCountable< IActionResponse > nx::sdk::ActionResponse

Public Member Functions

virtual const char * actionUrl () const =0
 
virtual const char * messageToUser () const =0
 
virtual bool useProxy () const =0
 
virtual bool useDeviceCredentials () const =0
 
- Public Member Functions inherited from nx::sdk::Interface< IActionResponse >
virtual IRefCountablequeryInterface (const InterfaceId *id)
 
Ptr< InterfacequeryInterface ()
 
Ptr< const InterfacequeryInterface () const
 
- Public Member Functions inherited from nx::sdk::IRefCountable
virtual ~IRefCountable ()=default
 
template<class Interface >
Ptr< InterfacequeryInterface ()
 
template<class Interface >
Ptr< const InterfacequeryInterface () const
 
virtual int addRef () const =0
 
virtual int releaseRef () const =0
 
int refCountThreadUnsafe () const
 

Static Public Member Functions

static auto interfaceId ()
 
- Static Public Member Functions inherited from nx::sdk::IRefCountable
static auto interfaceId ()
 

Additional Inherited Members

- Protected Member Functions inherited from nx::sdk::Interface< IActionResponse >
virtual IRefCountablequeryInterface (const IRefCountable::InterfaceId *id) override
 
IRefCountablequeryInterfaceSupportingDeprecatedId (const IRefCountable::InterfaceId *id, const Uuid &deprecatedInterfaceId)
 
- Static Protected Member Functions inherited from nx::sdk::IRefCountable
template<int len>
static constexpr const InterfaceIdmakeId (const char(&charArray)[len])
 
template<class TemplateInstance , class TemplateArg , int len>
static const InterfaceIdmakeIdForTemplate (const char(&baseIdCharArray)[len])
 

Detailed Description

Defines how the Client must interact with the user after the plugin executes some action triggered by the user.

Member Function Documentation

◆ actionUrl()

virtual const char* nx::sdk::IActionResponse::actionUrl ( ) const
pure virtual
Returns
URL to be opened by the Client in an embedded browser, or a null or empty string. If non-empty, messageToUser() must return a null or empty string.

Implemented in nx::sdk::ActionResponse.

◆ messageToUser()

virtual const char* nx::sdk::IActionResponse::messageToUser ( ) const
pure virtual
Returns
Text to be shown to the user by the Client, or a null or empty string. If non-empty, actionUrl() must return a null or empty string.

Implemented in nx::sdk::ActionResponse.

◆ useDeviceCredentials()

virtual bool nx::sdk::IActionResponse::useDeviceCredentials ( ) const
pure virtual
Returns
Whether device authentication should be used for actionUrl().

Implemented in nx::sdk::ActionResponse.

◆ useProxy()

virtual bool nx::sdk::IActionResponse::useProxy ( ) const
pure virtual
Returns
Whether proxying through the connected server should be used for actionUrl().

Implemented in nx::sdk::ActionResponse.


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