IoTivity C++ SDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
OC::OCResourceResponse Class Reference

OCResourceResponse provides APIs to set the response details. More...

Public Types

typedef std::shared_ptr
< OCResourceResponse
Ptr
 

Public Member Functions

 OCResourceResponse ()
 
 OCResourceResponse (OCResourceResponse &&)=default
 
OCResourceResponseoperator= (OCResourceResponse &&)=default
 
virtual ~OCResourceResponse (void)
 
std::string getNewResourceUri (void)
 gets new resource uri More...
 
void setNewResourceUri (const std::string newResourceUri)
 sets new resource uri More...
 
void setHeaderOptions (const HeaderOptions &headerOptions)
 This API allows to set headerOptions in the response. More...
 
void setRequestHandle (const OCRequestHandle &requestHandle)
 This API allows to set request handle. More...
 
void setResourceHandle (const OCResourceHandle &resourceHandle)
 This API allows to set the resource handle. More...
 
void setResponseResult (const OCEntityHandlerResult &responseResult)
 This API allows to set the EntityHandler response result. More...
 
void setResourceRepresentation (OCRepresentation &rep, std::string iface)
 API to set the entire resource attribute representation. More...
 
void setResourceRepresentation (OCRepresentation &&rep, std::string iface)
 API to set the entire resource attribute representation. More...
 
void setResourceRepresentation (OCRepresentation &rep)
 API to set the entire resource attribute representation. More...
 
void setResourceRepresentation (OCRepresentation &&rep)
 API to set the entire resource attribute representation. More...
 
const OCRepresentationgetResourceRepresentation () const
 Get the Response Representation. More...
 
const HeaderOptionsgetHeaderOptions () const
 This API allows to retrieve headerOptions from a response. More...
 
const OCRequestHandlegetRequestHandle () const
 This API retrieves the request handle. More...
 
const OCResourceHandlegetResourceHandle () const
 This API retrieves the resource handle. More...
 
OCEntityHandlerResult getResponseResult () const
 This API retrieves the entity handle response result. More...
 

Friends

class InProcServerWrapper
 

Detailed Description

OCResourceResponse provides APIs to set the response details.

Member Typedef Documentation

Constructor & Destructor Documentation

OC::OCResourceResponse::OCResourceResponse ( )
inline
OC::OCResourceResponse::OCResourceResponse ( OCResourceResponse &&  )
default
virtual OC::OCResourceResponse::~OCResourceResponse ( void  )
inlinevirtual

Member Function Documentation

const HeaderOptions& OC::OCResourceResponse::getHeaderOptions ( ) const
inline

This API allows to retrieve headerOptions from a response.

std::string OC::OCResourceResponse::getNewResourceUri ( void  )
inline

gets new resource uri

Returns
std::string new resource uri
const OCRequestHandle& OC::OCResourceResponse::getRequestHandle ( ) const
inline

This API retrieves the request handle.

Returns
OCRequestHandle value
const OCResourceHandle& OC::OCResourceResponse::getResourceHandle ( ) const
inline

This API retrieves the resource handle.

Returns
OCResourceHandle value
const OCRepresentation& OC::OCResourceResponse::getResourceRepresentation ( ) const
inline

Get the Response Representation.

OCEntityHandlerResult OC::OCResourceResponse::getResponseResult ( ) const
inline

This API retrieves the entity handle response result.

Returns
OCEntityHandler result value
OCResourceResponse& OC::OCResourceResponse::operator= ( OCResourceResponse &&  )
default
void OC::OCResourceResponse::setHeaderOptions ( const HeaderOptions headerOptions)
inline

This API allows to set headerOptions in the response.

Parameters
headerOptionsHeaderOptions vector consisting of OCHeaderOption objects
void OC::OCResourceResponse::setNewResourceUri ( const std::string  newResourceUri)
inline

sets new resource uri

Parameters
newResourceUrispecifies the resource uri of the resource created
void OC::OCResourceResponse::setRequestHandle ( const OCRequestHandle requestHandle)
inline

This API allows to set request handle.

Parameters
requestHandle- OCRequestHandle type used to set the request handle
void OC::OCResourceResponse::setResourceHandle ( const OCResourceHandle resourceHandle)
inline

This API allows to set the resource handle.

Parameters
resourceHandle- OCResourceHandle type used to set the resource handle
void OC::OCResourceResponse::setResourceRepresentation ( OCRepresentation rep,
std::string  iface 
)
inline

API to set the entire resource attribute representation.

Parameters
repreference to the resource's representation
ifacespecifies the interface
void OC::OCResourceResponse::setResourceRepresentation ( OCRepresentation &&  rep,
std::string  iface 
)
inline

API to set the entire resource attribute representation.

Parameters
reprvalue reference to the resource's representation
ifacespecifies the interface
void OC::OCResourceResponse::setResourceRepresentation ( OCRepresentation rep)
inline

API to set the entire resource attribute representation.

Parameters
repreference to the resource's representation
void OC::OCResourceResponse::setResourceRepresentation ( OCRepresentation &&  rep)
inline

API to set the entire resource attribute representation.

Parameters
reprvalue reference to the resource's representation
void OC::OCResourceResponse::setResponseResult ( const OCEntityHandlerResult responseResult)
inline

This API allows to set the EntityHandler response result.

Parameters
responseResult- OCEntityHandlerResult type to set the result value

Friends And Related Function Documentation

friend class InProcServerWrapper
friend

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