IoTivity C++ SDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
OIC::Service::RemoteSceneAction Class Reference

Public Types

typedef std::shared_ptr
< RemoteSceneAction
Ptr
 
typedef std::function< void(int
eCode) > 
ResetExecutionParameterCallback
 Callback definition to be invoked when a response of resetExecutionParameter is received. More...
 

Public Member Functions

 ~RemoteSceneAction ()=default
 
void resetExecutionParameter (const std::string &key, const RCSResourceAttributes::Value &value, ResetExecutionParameterCallback cb)
 Requests to reset the RemoteSceneAction parameters like a target attribute key and its value. More...
 
void resetExecutionParameter (const RCSResourceAttributes &attr, ResetExecutionParameterCallback cb)
 Requests to reset the RemoteSceneAction parameters like a target attribute key and its value. More...
 
RCSResourceAttributes getExecutionParameter () const
 Returns an execution parameter of the SceneAction. More...
 
RCSRemoteResourceObject::Ptr getRemoteResourceObject () const
 Returns a target remote resource object of the RemoteSceneAction instance. More...
 

Friends

class RemoteScene
 

Member Typedef Documentation

typedef std::function< void(int eCode) > OIC::Service::RemoteSceneAction::ResetExecutionParameterCallback

Callback definition to be invoked when a response of resetExecutionParameter is received.

Parameters
eCodethe error code received on a remote-side scene resource server
Note
Error code '200' stands for success, '400' for bad request, and '500' for internal error.
See Also
resetExecutionParameter

Constructor & Destructor Documentation

OIC::Service::RemoteSceneAction::~RemoteSceneAction ( )
default

Member Function Documentation

RCSResourceAttributes OIC::Service::RemoteSceneAction::getExecutionParameter ( ) const

Returns an execution parameter of the SceneAction.

Returns
RCSResourceAttributes
RCSRemoteResourceObject::Ptr OIC::Service::RemoteSceneAction::getRemoteResourceObject ( ) const

Returns a target remote resource object of the RemoteSceneAction instance.

Returns
pointer of RCSRemoteResourceObject
void OIC::Service::RemoteSceneAction::resetExecutionParameter ( const std::string &  key,
const RCSResourceAttributes::Value value,
ResetExecutionParameterCallback  cb 
)

Requests to reset the RemoteSceneAction parameters like a target attribute key and its value.

Parameters
keykey of attribute
valuevalue to be mapped against the key
cbA callback to receive the response
Exceptions
RCSInvalidParameterExceptionIf parameter is invalid.
PlatformExceptionIf the platform operation failed
See Also
RCSResourceAttributes::Value
void OIC::Service::RemoteSceneAction::resetExecutionParameter ( const RCSResourceAttributes attr,
ResetExecutionParameterCallback  cb 
)

Requests to reset the RemoteSceneAction parameters like a target attribute key and its value.

Parameters
attrAttributes to set
cbA callback to receive the response
Exceptions
RCSInvalidParameterExceptionIf parameter is invalid.
PlatformExceptionIf the platform operation failed
See Also
RCSResourceAttributes

Friends And Related Function Documentation

friend class RemoteScene
friend

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