Chromium Embedded Framework (CEF)  116.0.6+gc182ee2+chromium-116.0.5845.10
CefResponse Class Referenceabstract

Class used to represent a web response. More...

#include "include/cef_response.h"

Inheritance diagram for CefResponse:
CefBaseRefCounted

Public Types

typedef std::multimap< CefString, CefStringHeaderMap
 

Public Member Functions

virtual bool IsReadOnly ()=0
 Returns true if this object is read-only. More...
 
virtual cef_errorcode_t GetError ()=0
 Get the response error code. More...
 
virtual void SetError (cef_errorcode_t error)=0
 Set the response error code. More...
 
virtual int GetStatus ()=0
 Get the response status code. More...
 
virtual void SetStatus (int status)=0
 Set the response status code. More...
 
virtual CefString GetStatusText ()=0
 Get the response status text. More...
 
virtual void SetStatusText (const CefString &statusText)=0
 Set the response status text. More...
 
virtual CefString GetMimeType ()=0
 Get the response mime type. More...
 
virtual void SetMimeType (const CefString &mimeType)=0
 Set the response mime type. More...
 
virtual CefString GetCharset ()=0
 Get the response charset. More...
 
virtual void SetCharset (const CefString &charset)=0
 Set the response charset. More...
 
virtual CefString GetHeaderByName (const CefString &name)=0
 Get the value for the specified response header field. More...
 
virtual void SetHeaderByName (const CefString &name, const CefString &value, bool overwrite)=0
 Set the header |name| to |value|. More...
 
virtual void GetHeaderMap (HeaderMap &headerMap)=0
 Get all response header fields. More...
 
virtual void SetHeaderMap (const HeaderMap &headerMap)=0
 Set all response header fields. More...
 
virtual CefString GetURL ()=0
 Get the resolved URL after redirects or changed as a result of HSTS. More...
 
virtual void SetURL (const CefString &url)=0
 Set the resolved URL after redirects or changed as a result of HSTS. More...
 
- Public Member Functions inherited from CefBaseRefCounted
virtual void AddRef () const =0
 Called to increment the reference count for the object. More...
 
virtual bool Release () const =0
 Called to decrement the reference count for the object. More...
 
virtual bool HasOneRef () const =0
 Returns true if the reference count is 1. More...
 
virtual bool HasAtLeastOneRef () const =0
 Returns true if the reference count is at least 1. More...
 

Static Public Member Functions

static CefRefPtr< CefResponseCreate ()
 Create a new CefResponse object. More...
 

Additional Inherited Members

- Protected Member Functions inherited from CefBaseRefCounted
virtual ~CefBaseRefCounted ()
 

Detailed Description

Class used to represent a web response.

The methods of this class may be called on any thread.

Member Typedef Documentation

◆ HeaderMap

typedef std::multimap<CefString, CefString> CefResponse::HeaderMap

Member Function Documentation

◆ Create()

static CefRefPtr<CefResponse> CefResponse::Create ( )
static

Create a new CefResponse object.

◆ GetCharset()

virtual CefString CefResponse::GetCharset ( )
pure virtual

Get the response charset.

◆ GetError()

virtual cef_errorcode_t CefResponse::GetError ( )
pure virtual

Get the response error code.

Returns ERR_NONE if there was no error.

◆ GetHeaderByName()

virtual CefString CefResponse::GetHeaderByName ( const CefString name)
pure virtual

Get the value for the specified response header field.

◆ GetHeaderMap()

virtual void CefResponse::GetHeaderMap ( HeaderMap headerMap)
pure virtual

Get all response header fields.

◆ GetMimeType()

virtual CefString CefResponse::GetMimeType ( )
pure virtual

Get the response mime type.

◆ GetStatus()

virtual int CefResponse::GetStatus ( )
pure virtual

Get the response status code.

◆ GetStatusText()

virtual CefString CefResponse::GetStatusText ( )
pure virtual

Get the response status text.

◆ GetURL()

virtual CefString CefResponse::GetURL ( )
pure virtual

Get the resolved URL after redirects or changed as a result of HSTS.

◆ IsReadOnly()

virtual bool CefResponse::IsReadOnly ( )
pure virtual

Returns true if this object is read-only.

◆ SetCharset()

virtual void CefResponse::SetCharset ( const CefString charset)
pure virtual

Set the response charset.

◆ SetError()

virtual void CefResponse::SetError ( cef_errorcode_t  error)
pure virtual

Set the response error code.

This can be used by custom scheme handlers to return errors during initial request processing.

◆ SetHeaderByName()

virtual void CefResponse::SetHeaderByName ( const CefString name,
const CefString value,
bool  overwrite 
)
pure virtual

Set the header |name| to |value|.

If |overwrite| is true any existing values will be replaced with the new value. If |overwrite| is false any existing values will not be overwritten.

◆ SetHeaderMap()

virtual void CefResponse::SetHeaderMap ( const HeaderMap headerMap)
pure virtual

Set all response header fields.

◆ SetMimeType()

virtual void CefResponse::SetMimeType ( const CefString mimeType)
pure virtual

Set the response mime type.

◆ SetStatus()

virtual void CefResponse::SetStatus ( int  status)
pure virtual

Set the response status code.

◆ SetStatusText()

virtual void CefResponse::SetStatusText ( const CefString statusText)
pure virtual

Set the response status text.

◆ SetURL()

virtual void CefResponse::SetURL ( const CefString url)
pure virtual

Set the resolved URL after redirects or changed as a result of HSTS.


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