LuciadCPillar C# 2023.1.04
Luciad.Net.Http.HttpResponse.Builder Class Reference

Builder for the luciad::HttpResponse class. More...

Inheritance diagram for Luciad.Net.Http.HttpResponse.Builder:

Public Member Functions

 Builder (Luciad.Net.Http.HttpResponse.Builder other)
 
Luciad.Net.Http.HttpResponse.Builder Body (Luciad.Containers.DataEntity body)
 Sets the HTTP response content. More...
 
Luciad.Net.Http.HttpResponse Build ()
 Returns an luciad::HttpResponse based on the properties set on this builder. More...
 
void Dispose ()
 
Luciad.Net.Http.HttpResponse.Builder Header (Luciad.Net.Http.HttpHeader header)
 
Luciad.Net.Http.HttpResponse.Builder Header (string name, string value)
 Sets the given name value pair to the set of headers for this response. More...
 
Luciad.Net.Http.HttpResponse.Builder StatusCode (int statusCode)
 Sets the status code of the HTTP response. More...
 

Detailed Description

Builder for the luciad::HttpResponse class.

Instances of HttpRequest::Builder are created by calling luciad::HttpResponse::newBuilder. 2023.0

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::HttpResponse::Builder.

Constructor & Destructor Documentation

◆ Builder()

Luciad.Net.Http.HttpResponse.Builder.Builder ( Luciad.Net.Http.HttpResponse.Builder  other)
inline

Member Function Documentation

◆ Body()

Luciad.Net.Http.HttpResponse.Builder Luciad.Net.Http.HttpResponse.Builder.Body ( Luciad.Containers.DataEntity  body)
inline

Sets the HTTP response content.

This parameter is optional.

body

the response content.

this builder.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::HttpResponse::Builder::body.

◆ Build()

Luciad.Net.Http.HttpResponse Luciad.Net.Http.HttpResponse.Builder.Build ( )
inline

Returns an luciad::HttpResponse based on the properties set on this builder.

an luciad::HttpResponse.

luciad::LogicException

if the status code for this response has not been set.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::HttpResponse::Builder::build.

◆ Dispose()

void Luciad.Net.Http.HttpResponse.Builder.Dispose ( )
inline

◆ Header() [1/2]

Luciad.Net.Http.HttpResponse.Builder Luciad.Net.Http.HttpResponse.Builder.Header ( Luciad.Net.Http.HttpHeader  header)
inline

◆ Header() [2/2]

Luciad.Net.Http.HttpResponse.Builder Luciad.Net.Http.HttpResponse.Builder.Header ( string  name,
string  value 
)
inline

Sets the given name value pair to the set of headers for this response.

name

header name

value

header value

this builder.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::HttpResponse::Builder::header.

◆ StatusCode()

Luciad.Net.Http.HttpResponse.Builder Luciad.Net.Http.HttpResponse.Builder.StatusCode ( int  statusCode)
inline

Sets the status code of the HTTP response.

This parameter is mandatory. If it is not set, HttpResponse::Builder::build will throw an exception.

statusCode

the status code for this response.

this builder.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::HttpResponse::Builder::statusCode.