Foxit PDF SDK
fsdk.SOAPRequestProperties Class Reference

Public Member Functions

def GetAuthenticate ()
 Get an object that specifies how to handle HTTP authentication or credentials to use for Web Service Security. More...
 
def GetContent_type ()
 Get allows the HTTP content-type header to be specified. More...
 
def GetIs_encode ()
 Get encoded the request using the SOAP Encoding described in the SOAP Specification. More...
 
def GetIs_wiredump ()
 Get whether to output debug information for SOAP requests and responses, defaults to true. More...
 
def GetRequest_content ()
 Get an object that specifies the remote procedure name and parameters or the XML message to send. More...
 
def GetRequest_header ()
 Get an object that specifies a SOAP header to be included with the request. More...
 
def GetRequest_url ()
 Get the URL for a SOAP HTTP endpoint. More...
 
def GetSoap_action ()
 Get the SOAP action is a URN written to an HTTP header used by firewalls and servers to filter SOAP requests. More...
 
def GetSoap_namespace ()
 Get a namespace for the message schema when the request does not use the SOAP Encoding. More...
 
def GetSoap_version ()
 Get the version of the SOAP protocol to use when generating the XML Message. More...
 
def Set (request_url, request_content, soap_action, soap_namespace, soap_version, content_type, is_encode, is_wiredump, request_header, authenticate)
 Set values.
More...
 
def SetAuthenticate (value)
 Set an object that specifies how to handle HTTP authentication or credentials to use for Web Service Security. More...
 
def SetContent_type (value)
 Set allows the HTTP content-type header to be specified. More...
 
def SetIs_encode (value)
 Set encoded the request using the SOAP Encoding described in the SOAP Specification. More...
 
def SetIs_wiredump (value)
 Set whether to output debug information for SOAP requests and responses, defaults to true. More...
 
def SetRequest_content (value)
 Set an object that specifies the remote procedure name and parameters or the XML message to send. More...
 
def SetRequest_header (value)
 Set an object that specifies a SOAP header to be included with the request. More...
 
def SetRequest_url (value)
 Set the URL for a SOAP HTTP endpoint. More...
 
def SetSoap_action (value)
 Set the SOAP action is a URN written to an HTTP header used by firewalls and servers to filter SOAP requests. More...
 
def SetSoap_namespace (value)
 Set a namespace for the message schema when the request does not use the SOAP Encoding. More...
 
def SetSoap_version (value)
 Set the version of the SOAP protocol to use when generating the XML Message. More...
 

Detailed Description

This class represents SOAP request properties.

Member Function Documentation

◆ GetAuthenticate()

fsdk.SOAPRequestProperties.GetAuthenticate ( )

Get an object that specifies how to handle HTTP authentication or credentials to use for Web Service Security.

Returns
An object that specifies how to handle HTTP authentication or credentials to use for Web Service Security.

◆ GetContent_type()

fsdk.SOAPRequestProperties.GetContent_type ( )

Get allows the HTTP content-type header to be specified.

Returns
Allows the HTTP content-type header to be specified. The default is to use the SOAP messaging HTTP content-type.

◆ GetIs_encode()

fsdk.SOAPRequestProperties.GetIs_encode ( )

Get encoded the request using the SOAP Encoding described in the SOAP Specification.

Returns
Encoded the request using the SOAP Encoding described in the SOAP Specification. Otherwise, the literal encoding is used.

◆ GetIs_wiredump()

fsdk.SOAPRequestProperties.GetIs_wiredump ( )

Get whether to output debug information for SOAP requests and responses, defaults to true.

Returns
Whether to output debug information for SOAP requests and responses, defaults to true.

◆ GetRequest_content()

fsdk.SOAPRequestProperties.GetRequest_content ( )

Get an object that specifies the remote procedure name and parameters or the XML message to send.

Returns
An object that specifies the remote procedure name and parameters or the XML message to send.

◆ GetRequest_header()

fsdk.SOAPRequestProperties.GetRequest_header ( )

Get an object that specifies a SOAP header to be included with the request.

Returns
An object that specifies a SOAP header to be included with the request. The default is to send a request with only a SOAP Body.

◆ GetRequest_url()

fsdk.SOAPRequestProperties.GetRequest_url ( )

Get the URL for a SOAP HTTP endpoint.

Returns
The URL for a SOAP HTTP endpoint.

◆ GetSoap_action()

fsdk.SOAPRequestProperties.GetSoap_action ( )

Get the SOAP action is a URN written to an HTTP header used by firewalls and servers to filter SOAP requests.

Returns
The SOAP action is a URN written to an HTTP header used by firewalls and servers to filter SOAP requests.

◆ GetSoap_namespace()

fsdk.SOAPRequestProperties.GetSoap_namespace ( )

Get a namespace for the message schema when the request does not use the SOAP Encoding.

The default is to omit the schema declaration.

Returns
A namespace for the message schema when the request does not use the SOAP Encoding.

◆ GetSoap_version()

fsdk.SOAPRequestProperties.GetSoap_version ( )

Get the version of the SOAP protocol to use when generating the XML Message.

Returns
The version of the SOAP protocol to use when generating the XML Message.

◆ Set()

def fsdk.SOAPRequestProperties.Set (   request_url,
  request_content,
  soap_action,
  soap_namespace,
  soap_version,
  content_type,
  is_encode,
  is_wiredump,
  request_header,
  authenticate 
)

Set values.

Parameters
[in]request_urlThe URL for a SOAP HTTP endpoint.
[in]request_contentAn object that specifies the remote procedure name and parameters or the XML message to send.
[in]soap_actionThe SOAP action is a URN written to an HTTP header used by firewalls and servers to filter SOAP requests.
[in]soap_namespaceA namespace for the message schema when the request does not use the SOAP Encoding.
[in]soap_versionThe version of the SOAP protocol to use when generating the XML Message.
[in]content_typeAllows the HTTP content-type header to be specified. The default is to use the SOAP messaging HTTP content-type.
[in]is_encodeEncoded the request using the SOAP Encoding described in the SOAP Specification. Otherwise, the literal encoding is used.
[in]is_wiredumpWhether to output debug information for SOAP requests and responses, defaults to true.
[in]request_headerAn object that specifies a SOAP header to be included with the request. The default is to send a request with only a SOAP Body
[in]authenticateAn object that specifies how to handle HTTP authentication or credentials to use for Web Service Security.
Returns
None.

◆ SetAuthenticate()

fsdk.SOAPRequestProperties.SetAuthenticate (   value)

Set an object that specifies how to handle HTTP authentication or credentials to use for Web Service Security.

Parameters
[in]valueAn object that specifies how to handle HTTP authentication or credentials to use for Web Service Security.
Returns
None.

◆ SetContent_type()

fsdk.SOAPRequestProperties.SetContent_type (   value)

Set allows the HTTP content-type header to be specified.

Parameters
[in]valueAllows the HTTP content-type header to be specified. The default is to use the SOAP messaging HTTP content-type.
Returns
None.

◆ SetIs_encode()

fsdk.SOAPRequestProperties.SetIs_encode (   value)

Set encoded the request using the SOAP Encoding described in the SOAP Specification.

Parameters
[in]valueEncoded the request using the SOAP Encoding described in the SOAP Specification. Otherwise, the literal encoding is used.
Returns
None.

◆ SetIs_wiredump()

fsdk.SOAPRequestProperties.SetIs_wiredump (   value)

Set whether to output debug information for SOAP requests and responses, defaults to true.

Parameters
[in]valueWhether to output debug information for SOAP requests and responses, defaults to true.
Returns
None.

◆ SetRequest_content()

fsdk.SOAPRequestProperties.SetRequest_content (   value)

Set an object that specifies the remote procedure name and parameters or the XML message to send.

Parameters
[in]valueAn object that specifies the remote procedure name and parameters or the XML message to send.
Returns
None.

◆ SetRequest_header()

fsdk.SOAPRequestProperties.SetRequest_header (   value)

Set an object that specifies a SOAP header to be included with the request.

Parameters
[in]valueAn object that specifies a SOAP header to be included with the request. The default is to send a request with only a SOAP Body.
Returns
None.

◆ SetRequest_url()

fsdk.SOAPRequestProperties.SetRequest_url (   value)

Set the URL for a SOAP HTTP endpoint.

Parameters
[in]valueThe URL for a SOAP HTTP endpoint.
Returns
None.

◆ SetSoap_action()

fsdk.SOAPRequestProperties.SetSoap_action (   value)

Set the SOAP action is a URN written to an HTTP header used by firewalls and servers to filter SOAP requests.

Parameters
[in]valueThe SOAP action is a URN written to an HTTP header used by firewalls and servers to filter SOAP requests.
Returns
None.

◆ SetSoap_namespace()

fsdk.SOAPRequestProperties.SetSoap_namespace (   value)

Set a namespace for the message schema when the request does not use the SOAP Encoding.

The default is to omit the schema declaration.

Parameters
[in]valueA namespace for the message schema when the request does not use the SOAP Encoding.
Returns
None.

◆ SetSoap_version()

fsdk.SOAPRequestProperties.SetSoap_version (   value)

Set the version of the SOAP protocol to use when generating the XML Message.

Parameters
[in]valueThe version of the SOAP protocol to use when generating the XML Message.
Returns
None.