RESTClient Class

Properties   Methods   Events   Config Settings   Errors  

The RESTClient class implements client-side functionality for the REST protocol.

Syntax

RESTClient

Remarks

RESTClient allows you to send requests to a REST server and receive server responses. It supports both plain (HTTP) and secure (HTTPS) modes.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

BlockedCertCount Property (RESTClient Class)

The number of records in the BlockedCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount);

Unicode (Windows)
INT GetBlockedCertCount();
INT SetBlockedCertCount(INT iBlockedCertCount);

int secureblackbox_restclient_getblockedcertcount(void* lpObj);
int secureblackbox_restclient_setblockedcertcount(void* lpObj, int iBlockedCertCount);

int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• BlockedCertBytes
• BlockedCertHandle

The array indices start at 0 and end at BlockedCertCount - 1.

This property is not available at design time.

Data Type

Integer

BlockedCertBytes Property (RESTClient Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBlockedCertBytes(int iBlockedCertIndex, char* &lpBlockedCertBytes, int &lenBlockedCertBytes);

Unicode (Windows)
INT GetBlockedCertBytes(INT iBlockedCertIndex, LPSTR &lpBlockedCertBytes, INT &lenBlockedCertBytes);

int secureblackbox_restclient_getblockedcertbytes(void* lpObj, int blockedcertindex, char** lpBlockedCertBytes, int* lenBlockedCertBytes);

QByteArray GetBlockedCertBytes(int iBlockedCertIndex);

Remarks

Returns the raw certificate data in DER format.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

BlockedCertHandle Property (RESTClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, int64 lBlockedCertHandle);

Unicode (Windows)
LONG64 GetBlockedCertHandle(INT iBlockedCertIndex);
INT SetBlockedCertHandle(INT iBlockedCertIndex, LONG64 lBlockedCertHandle);

int64 secureblackbox_restclient_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_restclient_setblockedcerthandle(void* lpObj, int blockedcertindex, int64 lBlockedCertHandle);

qint64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, qint64 lBlockedCertHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is not available at design time.

Data Type

Long64

ClientCertCount Property (RESTClient Class)

The number of records in the ClientCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientCertCount();
int SetClientCertCount(int iClientCertCount);

Unicode (Windows)
INT GetClientCertCount();
INT SetClientCertCount(INT iClientCertCount);

int secureblackbox_restclient_getclientcertcount(void* lpObj);
int secureblackbox_restclient_setclientcertcount(void* lpObj, int iClientCertCount);

int GetClientCertCount();
int SetClientCertCount(int iClientCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ClientCertBytes
• ClientCertHandle

The array indices start at 0 and end at ClientCertCount - 1.

This property is not available at design time.

Data Type

Integer

ClientCertBytes Property (RESTClient Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientCertBytes(int iClientCertIndex, char* &lpClientCertBytes, int &lenClientCertBytes);

Unicode (Windows)
INT GetClientCertBytes(INT iClientCertIndex, LPSTR &lpClientCertBytes, INT &lenClientCertBytes);

int secureblackbox_restclient_getclientcertbytes(void* lpObj, int clientcertindex, char** lpClientCertBytes, int* lenClientCertBytes);

QByteArray GetClientCertBytes(int iClientCertIndex);

Remarks

Returns the raw certificate data in DER format.

The ClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

ClientCertHandle Property (RESTClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetClientCertHandle(int iClientCertIndex);
int SetClientCertHandle(int iClientCertIndex, int64 lClientCertHandle);

Unicode (Windows)
LONG64 GetClientCertHandle(INT iClientCertIndex);
INT SetClientCertHandle(INT iClientCertIndex, LONG64 lClientCertHandle);

int64 secureblackbox_restclient_getclientcerthandle(void* lpObj, int clientcertindex);
int secureblackbox_restclient_setclientcerthandle(void* lpObj, int clientcertindex, int64 lClientCertHandle);

qint64 GetClientCertHandle(int iClientCertIndex);
int SetClientCertHandle(int iClientCertIndex, qint64 lClientCertHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The ClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCertCount property.

This property is not available at design time.

Data Type

Long64

ConnInfoAEADCipher Property (RESTClient Class)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoAEADCipher();

Unicode (Windows)
BOOL GetConnInfoAEADCipher();

int secureblackbox_restclient_getconninfoaeadcipher(void* lpObj);

bool GetConnInfoAEADCipher();

Default Value

FALSE

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoChainValidationDetails Property (RESTClient Class)

The details of a certificate chain validation outcome.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoChainValidationDetails();

Unicode (Windows)
INT GetConnInfoChainValidationDetails();

int secureblackbox_restclient_getconninfochainvalidationdetails(void* lpObj);

int GetConnInfoChainValidationDetails();

Default Value

0

Remarks

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

This property is read-only and not available at design time.

Data Type

Integer

ConnInfoChainValidationResult Property (RESTClient Class)

The outcome of a certificate chain validation routine.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoChainValidationResult();

Unicode (Windows)
INT GetConnInfoChainValidationResult();

CVT_VALID(0), 
CVT_VALID_BUT_UNTRUSTED(1), 
CVT_INVALID(2), 
CVT_CANT_BE_ESTABLISHED(3)

int secureblackbox_restclient_getconninfochainvalidationresult(void* lpObj);

int GetConnInfoChainValidationResult();

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

This property is read-only and not available at design time.

Data Type

Integer

ConnInfoCiphersuite Property (RESTClient Class)

The cipher suite employed by this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoCiphersuite();

Unicode (Windows)
LPWSTR GetConnInfoCiphersuite();

char* secureblackbox_restclient_getconninfociphersuite(void* lpObj);

QString GetConnInfoCiphersuite();

Default Value

""

Remarks

The cipher suite employed by this connection.

For TLS connections, this property returns the ciphersuite that was/is employed by the connection.

This property is read-only and not available at design time.

Data Type

String

ConnInfoClientAuthenticated Property (RESTClient Class)

Specifies whether client authentication was performed during this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoClientAuthenticated();

Unicode (Windows)
BOOL GetConnInfoClientAuthenticated();

int secureblackbox_restclient_getconninfoclientauthenticated(void* lpObj);

bool GetConnInfoClientAuthenticated();

Default Value

FALSE

Remarks

Specifies whether client authentication was performed during this connection.

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoClientAuthRequested Property (RESTClient Class)

Specifies whether client authentication was requested during this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoClientAuthRequested();

Unicode (Windows)
BOOL GetConnInfoClientAuthRequested();

int secureblackbox_restclient_getconninfoclientauthrequested(void* lpObj);

bool GetConnInfoClientAuthRequested();

Default Value

FALSE

Remarks

Specifies whether client authentication was requested during this connection.

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoConnectionEstablished Property (RESTClient Class)

Indicates whether the connection has been established fully.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoConnectionEstablished();

Unicode (Windows)
BOOL GetConnInfoConnectionEstablished();

int secureblackbox_restclient_getconninfoconnectionestablished(void* lpObj);

bool GetConnInfoConnectionEstablished();

Default Value

FALSE

Remarks

Indicates whether the connection has been established fully.

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoConnectionID Property (RESTClient Class)

The unique identifier assigned to this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoConnectionID(char* &lpConnInfoConnectionID, int &lenConnInfoConnectionID);

Unicode (Windows)
INT GetConnInfoConnectionID(LPSTR &lpConnInfoConnectionID, INT &lenConnInfoConnectionID);

int secureblackbox_restclient_getconninfoconnectionid(void* lpObj, char** lpConnInfoConnectionID, int* lenConnInfoConnectionID);

QByteArray GetConnInfoConnectionID();

Remarks

The unique identifier assigned to this connection.

This property is read-only and not available at design time.

Data Type

Byte Array

ConnInfoDigestAlgorithm Property (RESTClient Class)

The digest algorithm used in a TLS-enabled connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoDigestAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoDigestAlgorithm();

char* secureblackbox_restclient_getconninfodigestalgorithm(void* lpObj);

QString GetConnInfoDigestAlgorithm();

Default Value

""

Remarks

The digest algorithm used in a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

String

ConnInfoEncryptionAlgorithm Property (RESTClient Class)

The symmetric encryption algorithm used in a TLS-enabled connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoEncryptionAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoEncryptionAlgorithm();

char* secureblackbox_restclient_getconninfoencryptionalgorithm(void* lpObj);

QString GetConnInfoEncryptionAlgorithm();

Default Value

""

Remarks

The symmetric encryption algorithm used in a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

String

ConnInfoExportable Property (RESTClient Class)

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoExportable();

Unicode (Windows)
BOOL GetConnInfoExportable();

int secureblackbox_restclient_getconninfoexportable(void* lpObj);

bool GetConnInfoExportable();

Default Value

FALSE

Remarks

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoKeyExchangeAlgorithm Property (RESTClient Class)

The key exchange algorithm used in a TLS-enabled connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoKeyExchangeAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoKeyExchangeAlgorithm();

char* secureblackbox_restclient_getconninfokeyexchangealgorithm(void* lpObj);

QString GetConnInfoKeyExchangeAlgorithm();

Default Value

""

Remarks

The key exchange algorithm used in a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

String

ConnInfoKeyExchangeKeyBits Property (RESTClient Class)

The length of the key exchange key of a TLS-enabled connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoKeyExchangeKeyBits();

Unicode (Windows)
INT GetConnInfoKeyExchangeKeyBits();

int secureblackbox_restclient_getconninfokeyexchangekeybits(void* lpObj);

int GetConnInfoKeyExchangeKeyBits();

Default Value

0

Remarks

The length of the key exchange key of a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

Integer

ConnInfoNamedECCurve Property (RESTClient Class)

The elliptic curve used in this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoNamedECCurve();

Unicode (Windows)
LPWSTR GetConnInfoNamedECCurve();

char* secureblackbox_restclient_getconninfonamedeccurve(void* lpObj);

QString GetConnInfoNamedECCurve();

Default Value

""

Remarks

The elliptic curve used in this connection.

This property is read-only and not available at design time.

Data Type

String

ConnInfoPFSCipher Property (RESTClient Class)

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoPFSCipher();

Unicode (Windows)
BOOL GetConnInfoPFSCipher();

int secureblackbox_restclient_getconninfopfscipher(void* lpObj);

bool GetConnInfoPFSCipher();

Default Value

FALSE

Remarks

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoPreSharedIdentityHint Property (RESTClient Class)

A hint professed by the server to help the client select the PSK identity to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoPreSharedIdentityHint();

Unicode (Windows)
LPWSTR GetConnInfoPreSharedIdentityHint();

char* secureblackbox_restclient_getconninfopresharedidentityhint(void* lpObj);

QString GetConnInfoPreSharedIdentityHint();

Default Value

""

Remarks

A hint professed by the server to help the client select the PSK identity to use.

This property is read-only and not available at design time.

Data Type

String

ConnInfoPublicKeyBits Property (RESTClient Class)

The length of the public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoPublicKeyBits();

Unicode (Windows)
INT GetConnInfoPublicKeyBits();

int secureblackbox_restclient_getconninfopublickeybits(void* lpObj);

int GetConnInfoPublicKeyBits();

Default Value

0

Remarks

The length of the public key.

This property is read-only and not available at design time.

Data Type

Integer

ConnInfoResumedSession Property (RESTClient Class)

Indicates whether a TLS-enabled connection was spawned from another TLS connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoResumedSession();

Unicode (Windows)
BOOL GetConnInfoResumedSession();

int secureblackbox_restclient_getconninforesumedsession(void* lpObj);

bool GetConnInfoResumedSession();

Default Value

FALSE

Remarks

Indicates whether a TLS-enabled connection was spawned from another TLS connection

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoSecureConnection Property (RESTClient Class)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoSecureConnection();

Unicode (Windows)
BOOL GetConnInfoSecureConnection();

int secureblackbox_restclient_getconninfosecureconnection(void* lpObj);

bool GetConnInfoSecureConnection();

Default Value

FALSE

Remarks

Indicates whether TLS or SSL is enabled for this connection.

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoServerAuthenticated Property (RESTClient Class)

Indicates whether server authentication was performed during a TLS-enabled connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoServerAuthenticated();

Unicode (Windows)
BOOL GetConnInfoServerAuthenticated();

int secureblackbox_restclient_getconninfoserverauthenticated(void* lpObj);

bool GetConnInfoServerAuthenticated();

Default Value

FALSE

Remarks

Indicates whether server authentication was performed during a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoSignatureAlgorithm Property (RESTClient Class)

The signature algorithm used in a TLS handshake.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoSignatureAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoSignatureAlgorithm();

char* secureblackbox_restclient_getconninfosignaturealgorithm(void* lpObj);

QString GetConnInfoSignatureAlgorithm();

Default Value

""

Remarks

The signature algorithm used in a TLS handshake.

This property is read-only and not available at design time.

Data Type

String

ConnInfoSymmetricBlockSize Property (RESTClient Class)

The block size of the symmetric algorithm used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoSymmetricBlockSize();

Unicode (Windows)
INT GetConnInfoSymmetricBlockSize();

int secureblackbox_restclient_getconninfosymmetricblocksize(void* lpObj);

int GetConnInfoSymmetricBlockSize();

Default Value

0

Remarks

The block size of the symmetric algorithm used.

This property is read-only and not available at design time.

Data Type

Integer

ConnInfoSymmetricKeyBits Property (RESTClient Class)

The key length of the symmetric algorithm used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoSymmetricKeyBits();

Unicode (Windows)
INT GetConnInfoSymmetricKeyBits();

int secureblackbox_restclient_getconninfosymmetrickeybits(void* lpObj);

int GetConnInfoSymmetricKeyBits();

Default Value

0

Remarks

The key length of the symmetric algorithm used.

This property is read-only and not available at design time.

Data Type

Integer

ConnInfoTotalBytesReceived Property (RESTClient Class)

The total number of bytes received over this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetConnInfoTotalBytesReceived();

Unicode (Windows)
LONG64 GetConnInfoTotalBytesReceived();

int64 secureblackbox_restclient_getconninfototalbytesreceived(void* lpObj);

qint64 GetConnInfoTotalBytesReceived();

Default Value

0

Remarks

The total number of bytes received over this connection.

This property is read-only and not available at design time.

Data Type

Long64

ConnInfoTotalBytesSent Property (RESTClient Class)

The total number of bytes sent over this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetConnInfoTotalBytesSent();

Unicode (Windows)
LONG64 GetConnInfoTotalBytesSent();

int64 secureblackbox_restclient_getconninfototalbytessent(void* lpObj);

qint64 GetConnInfoTotalBytesSent();

Default Value

0

Remarks

The total number of bytes sent over this connection.

This property is read-only and not available at design time.

Data Type

Long64

ConnInfoValidationLog Property (RESTClient Class)

Contains the server certificate's chain validation log.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoValidationLog();

Unicode (Windows)
LPWSTR GetConnInfoValidationLog();

char* secureblackbox_restclient_getconninfovalidationlog(void* lpObj);

QString GetConnInfoValidationLog();

Default Value

""

Remarks

Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.

This property is read-only and not available at design time.

Data Type

String

ConnInfoVersion Property (RESTClient Class)

Indicates the version of SSL/TLS protocol negotiated during this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoVersion();

Unicode (Windows)
LPWSTR GetConnInfoVersion();

char* secureblackbox_restclient_getconninfoversion(void* lpObj);

QString GetConnInfoVersion();

Default Value

""

Remarks

Indicates the version of SSL/TLS protocol negotiated during this connection.

This property is read-only and not available at design time.

Data Type

String

CustomRequest Property (RESTClient Class)

Specifies a custom request verb.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomRequest();
int SetCustomRequest(const char* lpszCustomRequest);

Unicode (Windows)
LPWSTR GetCustomRequest();
INT SetCustomRequest(LPCWSTR lpszCustomRequest);

char* secureblackbox_restclient_getcustomrequest(void* lpObj);
int secureblackbox_restclient_setcustomrequest(void* lpObj, const char* lpszCustomRequest);

QString GetCustomRequest();
int SetCustomRequest(QString qsCustomRequest);

Default Value

""

Remarks

Use this property to specify a custom HTTP method verb to use instead of the original method. PATCH is one of the commonly used custom verbs.

This property is not available at design time.

Data Type

String

DynamicData Property (RESTClient Class)

Takes a piece of data to be sent to the server within a dynamic POST or PUT request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDynamicData(char* &lpDynamicData, int &lenDynamicData);
int SetDynamicData(const char* lpDynamicData, int lenDynamicData);

Unicode (Windows)
INT GetDynamicData(LPSTR &lpDynamicData, INT &lenDynamicData);
INT SetDynamicData(LPCSTR lpDynamicData, INT lenDynamicData);

int secureblackbox_restclient_getdynamicdata(void* lpObj, char** lpDynamicData, int* lenDynamicData);
int secureblackbox_restclient_setdynamicdata(void* lpObj, const char* lpDynamicData, int lenDynamicData);

QByteArray GetDynamicData();
int SetDynamicData(QByteArray qbaDynamicData);

Remarks

Assign the next chunk of data to this property from your DynamicDataNeeded event handler to pass it to the server. Leave it empty to tell the component that no more data is available.

This property is not available at design time.

Data Type

Byte Array

ExternalCryptoAsyncDocumentID Property (RESTClient Class)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(const char* lpszExternalCryptoAsyncDocumentID);

Unicode (Windows)
LPWSTR GetExternalCryptoAsyncDocumentID();
INT SetExternalCryptoAsyncDocumentID(LPCWSTR lpszExternalCryptoAsyncDocumentID);

char* secureblackbox_restclient_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_restclient_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);

QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID);

Default Value

""

Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (RESTClient Class)

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(const char* lpszExternalCryptoCustomParams);

Unicode (Windows)
LPWSTR GetExternalCryptoCustomParams();
INT SetExternalCryptoCustomParams(LPCWSTR lpszExternalCryptoCustomParams);

char* secureblackbox_restclient_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_restclient_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);

QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams);

Default Value

""

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (RESTClient Class)

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoData();
int SetExternalCryptoData(const char* lpszExternalCryptoData);

Unicode (Windows)
LPWSTR GetExternalCryptoData();
INT SetExternalCryptoData(LPCWSTR lpszExternalCryptoData);

char* secureblackbox_restclient_getexternalcryptodata(void* lpObj);
int secureblackbox_restclient_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);

QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData);

Default Value

""

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (RESTClient Class)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(int bExternalCryptoExternalHashCalculation);

Unicode (Windows)
BOOL GetExternalCryptoExternalHashCalculation();
INT SetExternalCryptoExternalHashCalculation(BOOL bExternalCryptoExternalHashCalculation);

int secureblackbox_restclient_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_restclient_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);

bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation);

Default Value

FALSE

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.

If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (RESTClient Class)

Specifies the request's signature hash algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(const char* lpszExternalCryptoHashAlgorithm);

Unicode (Windows)
LPWSTR GetExternalCryptoHashAlgorithm();
INT SetExternalCryptoHashAlgorithm(LPCWSTR lpszExternalCryptoHashAlgorithm);

char* secureblackbox_restclient_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_restclient_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);

QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm);

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (RESTClient Class)

The ID of the pre-shared key used for DC request authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(const char* lpszExternalCryptoKeyID);

Unicode (Windows)
LPWSTR GetExternalCryptoKeyID();
INT SetExternalCryptoKeyID(LPCWSTR lpszExternalCryptoKeyID);

char* secureblackbox_restclient_getexternalcryptokeyid(void* lpObj);
int secureblackbox_restclient_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);

QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID);

Default Value

""

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example:

 
 Copy
  signer.ExternalCrypto.KeyID = "MainSigningKey";
  signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (RESTClient Class)

The pre-shared key used for DC request authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(const char* lpszExternalCryptoKeySecret);

Unicode (Windows)
LPWSTR GetExternalCryptoKeySecret();
INT SetExternalCryptoKeySecret(LPCWSTR lpszExternalCryptoKeySecret);

char* secureblackbox_restclient_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_restclient_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);

QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret);

Default Value

""

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (RESTClient Class)

Specifies the asynchronous signing method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

Unicode (Windows)
INT GetExternalCryptoMethod();
INT SetExternalCryptoMethod(INT iExternalCryptoMethod);

ASMD_PKCS1(0), 
ASMD_PKCS7(1)

int secureblackbox_restclient_getexternalcryptomethod(void* lpObj);
int secureblackbox_restclient_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);

int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

Default Value

0

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

Data Type

Integer

ExternalCryptoMode Property (RESTClient Class)

Specifies the external cryptography mode.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

Unicode (Windows)
INT GetExternalCryptoMode();
INT SetExternalCryptoMode(INT iExternalCryptoMode);

ECM_DEFAULT(0), 
ECM_DISABLED(1), 
ECM_GENERIC(2), 
ECM_DCAUTH(3), 
ECM_DCAUTH_JSON(4)

int secureblackbox_restclient_getexternalcryptomode(void* lpObj);
int secureblackbox_restclient_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);

int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (RESTClient Class)

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(const char* lpszExternalCryptoPublicKeyAlgorithm);

Unicode (Windows)
LPWSTR GetExternalCryptoPublicKeyAlgorithm();
INT SetExternalCryptoPublicKeyAlgorithm(LPCWSTR lpszExternalCryptoPublicKeyAlgorithm);

char* secureblackbox_restclient_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_restclient_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);

QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);

Default Value

""

Remarks

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Data Type

String

FIPSMode Property (RESTClient Class)

Reserved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);

int secureblackbox_restclient_getfipsmode(void* lpObj);
int secureblackbox_restclient_setfipsmode(void* lpObj, int bFIPSMode);

bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

KeepAlivePolicy Property (RESTClient Class)

Defines the keep-alive handling policy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeepAlivePolicy();
int SetKeepAlivePolicy(int iKeepAlivePolicy);

Unicode (Windows)
INT GetKeepAlivePolicy();
INT SetKeepAlivePolicy(INT iKeepAlivePolicy);

CKAP_STANDARD_DEFINED(0), 
CKAP_PREFER_KEEP_ALIVE(1), 
CKAP_RELY_ON_SERVER(2), 
CKAP_KEEP_ALIVES_DISABLED(3)

int secureblackbox_restclient_getkeepalivepolicy(void* lpObj);
int secureblackbox_restclient_setkeepalivepolicy(void* lpObj, int iKeepAlivePolicy);

int GetKeepAlivePolicy();
int SetKeepAlivePolicy(int iKeepAlivePolicy);

Default Value

0

Remarks

Use this property to tune-up the keep-alive mechanism as per the needs of your application.

Data Type

Integer

KnownCertCount Property (RESTClient Class)

The number of records in the KnownCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

Unicode (Windows)
INT GetKnownCertCount();
INT SetKnownCertCount(INT iKnownCertCount);

int secureblackbox_restclient_getknowncertcount(void* lpObj);
int secureblackbox_restclient_setknowncertcount(void* lpObj, int iKnownCertCount);

int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCertBytes
• KnownCertHandle

The array indices start at 0 and end at KnownCertCount - 1.

This property is not available at design time.

Data Type

Integer

KnownCertBytes Property (RESTClient Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownCertBytes(int iKnownCertIndex, char* &lpKnownCertBytes, int &lenKnownCertBytes);

Unicode (Windows)
INT GetKnownCertBytes(INT iKnownCertIndex, LPSTR &lpKnownCertBytes, INT &lenKnownCertBytes);

int secureblackbox_restclient_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);

QByteArray GetKnownCertBytes(int iKnownCertIndex);

Remarks

Returns the raw certificate data in DER format.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

KnownCertHandle Property (RESTClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, int64 lKnownCertHandle);

Unicode (Windows)
LONG64 GetKnownCertHandle(INT iKnownCertIndex);
INT SetKnownCertHandle(INT iKnownCertIndex, LONG64 lKnownCertHandle);

int64 secureblackbox_restclient_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_restclient_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);

qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is not available at design time.

Data Type

Long64

KnownCRLCount Property (RESTClient Class)

The number of records in the KnownCRL arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount);

Unicode (Windows)
INT GetKnownCRLCount();
INT SetKnownCRLCount(INT iKnownCRLCount);

int secureblackbox_restclient_getknowncrlcount(void* lpObj);
int secureblackbox_restclient_setknowncrlcount(void* lpObj, int iKnownCRLCount);

int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCRLBytes
• KnownCRLHandle

The array indices start at 0 and end at KnownCRLCount - 1.

This property is not available at design time.

Data Type

Integer

KnownCRLBytes Property (RESTClient Class)

Returns the raw CRL data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownCRLBytes(int iKnownCRLIndex, char* &lpKnownCRLBytes, int &lenKnownCRLBytes);

Unicode (Windows)
INT GetKnownCRLBytes(INT iKnownCRLIndex, LPSTR &lpKnownCRLBytes, INT &lenKnownCRLBytes);

int secureblackbox_restclient_getknowncrlbytes(void* lpObj, int knowncrlindex, char** lpKnownCRLBytes, int* lenKnownCRLBytes);

QByteArray GetKnownCRLBytes(int iKnownCRLIndex);

Remarks

Returns the raw CRL data in DER format.

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

KnownCRLHandle Property (RESTClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, int64 lKnownCRLHandle);

Unicode (Windows)
LONG64 GetKnownCRLHandle(INT iKnownCRLIndex);
INT SetKnownCRLHandle(INT iKnownCRLIndex, LONG64 lKnownCRLHandle);

int64 secureblackbox_restclient_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_restclient_setknowncrlhandle(void* lpObj, int knowncrlindex, int64 lKnownCRLHandle);

qint64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, qint64 lKnownCRLHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

This property is not available at design time.

Data Type

Long64

KnownOCSPCount Property (RESTClient Class)

The number of records in the KnownOCSP arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount);

Unicode (Windows)
INT GetKnownOCSPCount();
INT SetKnownOCSPCount(INT iKnownOCSPCount);

int secureblackbox_restclient_getknownocspcount(void* lpObj);
int secureblackbox_restclient_setknownocspcount(void* lpObj, int iKnownOCSPCount);

int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownOCSPBytes
• KnownOCSPHandle

The array indices start at 0 and end at KnownOCSPCount - 1.

This property is not available at design time.

Data Type

Integer

KnownOCSPBytes Property (RESTClient Class)

A buffer containing the raw OCSP response data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownOCSPBytes(int iKnownOCSPIndex, char* &lpKnownOCSPBytes, int &lenKnownOCSPBytes);

Unicode (Windows)
INT GetKnownOCSPBytes(INT iKnownOCSPIndex, LPSTR &lpKnownOCSPBytes, INT &lenKnownOCSPBytes);

int secureblackbox_restclient_getknownocspbytes(void* lpObj, int knownocspindex, char** lpKnownOCSPBytes, int* lenKnownOCSPBytes);

QByteArray GetKnownOCSPBytes(int iKnownOCSPIndex);

Remarks

A buffer containing the raw OCSP response data.

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

KnownOCSPHandle Property (RESTClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, int64 lKnownOCSPHandle);

Unicode (Windows)
LONG64 GetKnownOCSPHandle(INT iKnownOCSPIndex);
INT SetKnownOCSPHandle(INT iKnownOCSPIndex, LONG64 lKnownOCSPHandle);

int64 secureblackbox_restclient_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_restclient_setknownocsphandle(void* lpObj, int knownocspindex, int64 lKnownOCSPHandle);

qint64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, qint64 lKnownOCSPHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

This property is not available at design time.

Data Type

Long64

OutputBytes Property (RESTClient Class)

Contains the response content.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutputBytes(char* &lpOutputBytes, int &lenOutputBytes);

Unicode (Windows)
INT GetOutputBytes(LPSTR &lpOutputBytes, INT &lenOutputBytes);

int secureblackbox_restclient_getoutputbytes(void* lpObj, char** lpOutputBytes, int* lenOutputBytes);

QByteArray GetOutputBytes();

Remarks

Use this property to access the content received from the server in response to a prior request.

This property is read-only and not available at design time.

Data Type

Byte Array

OutputString Property (RESTClient Class)

Contains the response content.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutputString();

Unicode (Windows)
LPWSTR GetOutputString();

char* secureblackbox_restclient_getoutputstring(void* lpObj);

QString GetOutputString();

Default Value

""

Remarks

Use this property to access the content received from the server in response to a prior request, as a string.

This property is read-only and not available at design time.

Data Type

String

ProxyAddress Property (RESTClient Class)

The IP address of the proxy server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyAddress();
int SetProxyAddress(const char* lpszProxyAddress);

Unicode (Windows)
LPWSTR GetProxyAddress();
INT SetProxyAddress(LPCWSTR lpszProxyAddress);

char* secureblackbox_restclient_getproxyaddress(void* lpObj);
int secureblackbox_restclient_setproxyaddress(void* lpObj, const char* lpszProxyAddress);

QString GetProxyAddress();
int SetProxyAddress(QString qsProxyAddress);

Default Value

""

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (RESTClient Class)

The authentication type used by the proxy server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication);

Unicode (Windows)
INT GetProxyAuthentication();
INT SetProxyAuthentication(INT iProxyAuthentication);

PAT_NO_AUTHENTICATION(0), 
PAT_BASIC(1), 
PAT_DIGEST(2), 
PAT_NTLM(3)

int secureblackbox_restclient_getproxyauthentication(void* lpObj);
int secureblackbox_restclient_setproxyauthentication(void* lpObj, int iProxyAuthentication);

int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication);

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (RESTClient Class)

The password to authenticate to the proxy server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* secureblackbox_restclient_getproxypassword(void* lpObj);
int secureblackbox_restclient_setproxypassword(void* lpObj, const char* lpszProxyPassword);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

""

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (RESTClient Class)

The port on the proxy server to connect to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int secureblackbox_restclient_getproxyport(void* lpObj);
int secureblackbox_restclient_setproxyport(void* lpObj, int iProxyPort);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (RESTClient Class)

The type of the proxy server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType);

Unicode (Windows)
INT GetProxyProxyType();
INT SetProxyProxyType(INT iProxyProxyType);

CPT_NONE(0), 
CPT_SOCKS_4(1), 
CPT_SOCKS_5(2), 
CPT_WEB_TUNNEL(3), 
CPT_HTTP(4)

int secureblackbox_restclient_getproxyproxytype(void* lpObj);
int secureblackbox_restclient_setproxyproxytype(void* lpObj, int iProxyProxyType);

int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType);

Default Value

0

Remarks

The type of the proxy server.

The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.

Data Type

Integer

ProxyRequestHeaders Property (RESTClient Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyRequestHeaders();
int SetProxyRequestHeaders(const char* lpszProxyRequestHeaders);

Unicode (Windows)
LPWSTR GetProxyRequestHeaders();
INT SetProxyRequestHeaders(LPCWSTR lpszProxyRequestHeaders);

char* secureblackbox_restclient_getproxyrequestheaders(void* lpObj);
int secureblackbox_restclient_setproxyrequestheaders(void* lpObj, const char* lpszProxyRequestHeaders);

QString GetProxyRequestHeaders();
int SetProxyRequestHeaders(QString qsProxyRequestHeaders);

Default Value

""

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (RESTClient Class)

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyResponseBody();
int SetProxyResponseBody(const char* lpszProxyResponseBody);

Unicode (Windows)
LPWSTR GetProxyResponseBody();
INT SetProxyResponseBody(LPCWSTR lpszProxyResponseBody);

char* secureblackbox_restclient_getproxyresponsebody(void* lpObj);
int secureblackbox_restclient_setproxyresponsebody(void* lpObj, const char* lpszProxyResponseBody);

QString GetProxyResponseBody();
int SetProxyResponseBody(QString qsProxyResponseBody);

Default Value

""

Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Data Type

String

ProxyResponseHeaders Property (RESTClient Class)

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyResponseHeaders();
int SetProxyResponseHeaders(const char* lpszProxyResponseHeaders);

Unicode (Windows)
LPWSTR GetProxyResponseHeaders();
INT SetProxyResponseHeaders(LPCWSTR lpszProxyResponseHeaders);

char* secureblackbox_restclient_getproxyresponseheaders(void* lpObj);
int secureblackbox_restclient_setproxyresponseheaders(void* lpObj, const char* lpszProxyResponseHeaders);

QString GetProxyResponseHeaders();
int SetProxyResponseHeaders(QString qsProxyResponseHeaders);

Default Value

""

Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Data Type

String

ProxyUseIPv6 Property (RESTClient Class)

Specifies whether IPv6 should be used when connecting through the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyUseIPv6();
int SetProxyUseIPv6(int bProxyUseIPv6);

Unicode (Windows)
BOOL GetProxyUseIPv6();
INT SetProxyUseIPv6(BOOL bProxyUseIPv6);

int secureblackbox_restclient_getproxyuseipv6(void* lpObj);
int secureblackbox_restclient_setproxyuseipv6(void* lpObj, int bProxyUseIPv6);

bool GetProxyUseIPv6();
int SetProxyUseIPv6(bool bProxyUseIPv6);

Default Value

FALSE

Remarks

Specifies whether IPv6 should be used when connecting through the proxy.

Data Type

Boolean

ProxyUseProxy Property (RESTClient Class)

Enables or disables proxy-driven connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyUseProxy();
int SetProxyUseProxy(int bProxyUseProxy);

Unicode (Windows)
BOOL GetProxyUseProxy();
INT SetProxyUseProxy(BOOL bProxyUseProxy);

int secureblackbox_restclient_getproxyuseproxy(void* lpObj);
int secureblackbox_restclient_setproxyuseproxy(void* lpObj, int bProxyUseProxy);

bool GetProxyUseProxy();
int SetProxyUseProxy(bool bProxyUseProxy);

Default Value

FALSE

Remarks

Enables or disables proxy-driven connection.

Data Type

Boolean

ProxyUsername Property (RESTClient Class)

Specifies the username credential for proxy authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUsername();
int SetProxyUsername(const char* lpszProxyUsername);

Unicode (Windows)
LPWSTR GetProxyUsername();
INT SetProxyUsername(LPCWSTR lpszProxyUsername);

char* secureblackbox_restclient_getproxyusername(void* lpObj);
int secureblackbox_restclient_setproxyusername(void* lpObj, const char* lpszProxyUsername);

QString GetProxyUsername();
int SetProxyUsername(QString qsProxyUsername);

Default Value

""

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

ReasonPhrase Property (RESTClient Class)

Contains the Reason Phrase element of the server's response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReasonPhrase();

Unicode (Windows)
LPWSTR GetReasonPhrase();

char* secureblackbox_restclient_getreasonphrase(void* lpObj);

QString GetReasonPhrase();

Default Value

""

Remarks

Use this property to access the reason phrase supplied by the server in its response (such as OK in HTTP 200 OK).

This property is read-only and not available at design time.

Data Type

String

ReqHeaderCount Property (RESTClient Class)

The number of records in the ReqHeader arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReqHeaderCount();
int SetReqHeaderCount(int iReqHeaderCount);

Unicode (Windows)
INT GetReqHeaderCount();
INT SetReqHeaderCount(INT iReqHeaderCount);

int secureblackbox_restclient_getreqheadercount(void* lpObj);
int secureblackbox_restclient_setreqheadercount(void* lpObj, int iReqHeaderCount);

int GetReqHeaderCount();
int SetReqHeaderCount(int iReqHeaderCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ReqHeaderCategory
• ReqHeaderFormat
• ReqHeaderName
• ReqHeaderValue

The array indices start at 0 and end at ReqHeaderCount - 1.

This property is not available at design time.

Data Type

Integer

ReqHeaderCategory Property (RESTClient Class)

Specifies the string category of the contained value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqHeaderCategory(int iReqHeaderIndex);
int SetReqHeaderCategory(int iReqHeaderIndex, const char* lpszReqHeaderCategory);

Unicode (Windows)
LPWSTR GetReqHeaderCategory(INT iReqHeaderIndex);
INT SetReqHeaderCategory(INT iReqHeaderIndex, LPCWSTR lpszReqHeaderCategory);

char* secureblackbox_restclient_getreqheadercategory(void* lpObj, int reqheaderindex);
int secureblackbox_restclient_setreqheadercategory(void* lpObj, int reqheaderindex, const char* lpszReqHeaderCategory);

QString GetReqHeaderCategory(int iReqHeaderIndex);
int SetReqHeaderCategory(int iReqHeaderIndex, QString qsReqHeaderCategory);

Default Value

""

Remarks

Specifies the string category of the contained value.

This property allows to check or set the category (or type) associated with the contained value. Depending on the format used to load or save the string, the category parameter may or may not be used.

For example, for ASN.1 property lists the category contains the ASN.1 tag of the contained data (OCTETSTRING, UTF8STRING, INTEGER, ...). For basic (name, value) pairs, such as HTTP headers, the category parameter is not used.

The ReqHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReqHeaderCount property.

This property is not available at design time.

Data Type

String

ReqHeaderFormat Property (RESTClient Class)

Specifies the format (encoding) of the value contained in the Value property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReqHeaderFormat(int iReqHeaderIndex);
int SetReqHeaderFormat(int iReqHeaderIndex, int iReqHeaderFormat);

Unicode (Windows)
INT GetReqHeaderFormat(INT iReqHeaderIndex);
INT SetReqHeaderFormat(INT iReqHeaderIndex, INT iReqHeaderFormat);

int secureblackbox_restclient_getreqheaderformat(void* lpObj, int reqheaderindex);
int secureblackbox_restclient_setreqheaderformat(void* lpObj, int reqheaderindex, int iReqHeaderFormat);

int GetReqHeaderFormat(int iReqHeaderIndex);
int SetReqHeaderFormat(int iReqHeaderIndex, int iReqHeaderFormat);

Default Value

0

Remarks

Specifies the format (encoding) of the value contained in the ReqHeaderValue property.

Use this property to check or set the format of the contained value. Remember to provide the actual value in the appropriate format that matches this setting:

 
 Copy
  utils.NameValuePairs[0].Name = "key";
  utils.NameValuePairs[0].Format = svfBinary;
  utils.NameValuePairs[0].Name = "0a1b2c3d4e5f6071";

The following formats are currently supported:

The ReqHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReqHeaderCount property.

This property is not available at design time.

Data Type

Integer

ReqHeaderName Property (RESTClient Class)

The name element in a (name, value) pair.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqHeaderName(int iReqHeaderIndex);
int SetReqHeaderName(int iReqHeaderIndex, const char* lpszReqHeaderName);

Unicode (Windows)
LPWSTR GetReqHeaderName(INT iReqHeaderIndex);
INT SetReqHeaderName(INT iReqHeaderIndex, LPCWSTR lpszReqHeaderName);

char* secureblackbox_restclient_getreqheadername(void* lpObj, int reqheaderindex);
int secureblackbox_restclient_setreqheadername(void* lpObj, int reqheaderindex, const char* lpszReqHeaderName);

QString GetReqHeaderName(int iReqHeaderIndex);
int SetReqHeaderName(int iReqHeaderIndex, QString qsReqHeaderName);

Default Value

""

Remarks

The name element in a (name, value) pair.

The ReqHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReqHeaderCount property.

This property is not available at design time.

Data Type

String

ReqHeaderValue Property (RESTClient Class)

The value element in a (name, value) pair.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqHeaderValue(int iReqHeaderIndex);
int SetReqHeaderValue(int iReqHeaderIndex, const char* lpszReqHeaderValue);

Unicode (Windows)
LPWSTR GetReqHeaderValue(INT iReqHeaderIndex);
INT SetReqHeaderValue(INT iReqHeaderIndex, LPCWSTR lpszReqHeaderValue);

char* secureblackbox_restclient_getreqheadervalue(void* lpObj, int reqheaderindex);
int secureblackbox_restclient_setreqheadervalue(void* lpObj, int reqheaderindex, const char* lpszReqHeaderValue);

QString GetReqHeaderValue(int iReqHeaderIndex);
int SetReqHeaderValue(int iReqHeaderIndex, QString qsReqHeaderValue);

Default Value

""

Remarks

The value element in a (name, value) pair.

The ReqHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReqHeaderCount property.

This property is not available at design time.

Data Type

String

ReqParamsAccept Property (RESTClient Class)

Specifies the Accept header property of the HTTP request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsAccept();
int SetReqParamsAccept(const char* lpszReqParamsAccept);

Unicode (Windows)
LPWSTR GetReqParamsAccept();
INT SetReqParamsAccept(LPCWSTR lpszReqParamsAccept);

char* secureblackbox_restclient_getreqparamsaccept(void* lpObj);
int secureblackbox_restclient_setreqparamsaccept(void* lpObj, const char* lpszReqParamsAccept);

QString GetReqParamsAccept();
int SetReqParamsAccept(QString qsReqParamsAccept);

Default Value

""

Remarks

Specifies the Accept header field of the HTTP request. The Accept field defines which media types are accepted in the response.

This property is not available at design time.

Data Type

String

ReqParamsAcceptCharset Property (RESTClient Class)

Specifies the Accept-Charset header property of the HTTP request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsAcceptCharset();
int SetReqParamsAcceptCharset(const char* lpszReqParamsAcceptCharset);

Unicode (Windows)
LPWSTR GetReqParamsAcceptCharset();
INT SetReqParamsAcceptCharset(LPCWSTR lpszReqParamsAcceptCharset);

char* secureblackbox_restclient_getreqparamsacceptcharset(void* lpObj);
int secureblackbox_restclient_setreqparamsacceptcharset(void* lpObj, const char* lpszReqParamsAcceptCharset);

QString GetReqParamsAcceptCharset();
int SetReqParamsAcceptCharset(QString qsReqParamsAcceptCharset);

Default Value

""

Remarks

Specifies the Accept-Charset header field of the HTTP request. The Accept-Charset field specifies the character set which the client can understand.

This property is not available at design time.

Data Type

String

ReqParamsAcceptLanguage Property (RESTClient Class)

Specifies the Accept-Language header property of the HTTP request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsAcceptLanguage();
int SetReqParamsAcceptLanguage(const char* lpszReqParamsAcceptLanguage);

Unicode (Windows)
LPWSTR GetReqParamsAcceptLanguage();
INT SetReqParamsAcceptLanguage(LPCWSTR lpszReqParamsAcceptLanguage);

char* secureblackbox_restclient_getreqparamsacceptlanguage(void* lpObj);
int secureblackbox_restclient_setreqparamsacceptlanguage(void* lpObj, const char* lpszReqParamsAcceptLanguage);

QString GetReqParamsAcceptLanguage();
int SetReqParamsAcceptLanguage(QString qsReqParamsAcceptLanguage);

Default Value

""

Remarks

Specifies the Accept-Language header field of the HTTP request. The Accept-Language field specifies the language (and locale) which the client can understand.

This property is not available at design time.

Data Type

String

ReqParamsAcceptRangeEnd Property (RESTClient Class)

This property, in combination with AcceptRangeStart, defines the media-range of the HTTP request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetReqParamsAcceptRangeEnd();
int SetReqParamsAcceptRangeEnd(int64 lReqParamsAcceptRangeEnd);

Unicode (Windows)
LONG64 GetReqParamsAcceptRangeEnd();
INT SetReqParamsAcceptRangeEnd(LONG64 lReqParamsAcceptRangeEnd);

int64 secureblackbox_restclient_getreqparamsacceptrangeend(void* lpObj);
int secureblackbox_restclient_setreqparamsacceptrangeend(void* lpObj, int64 lReqParamsAcceptRangeEnd);

qint64 GetReqParamsAcceptRangeEnd();
int SetReqParamsAcceptRangeEnd(qint64 lReqParamsAcceptRangeEnd);

Default Value

0

Remarks

This property, in combination with AcceptRangeStart, defines the media-range of the HTTP request.

This property is not available at design time.

Data Type

Long64

ReqParamsAcceptRangeStart Property (RESTClient Class)

This property, in combination with AcceptRangeEnd, defines the media-range of the HTTP request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetReqParamsAcceptRangeStart();
int SetReqParamsAcceptRangeStart(int64 lReqParamsAcceptRangeStart);

Unicode (Windows)
LONG64 GetReqParamsAcceptRangeStart();
INT SetReqParamsAcceptRangeStart(LONG64 lReqParamsAcceptRangeStart);

int64 secureblackbox_restclient_getreqparamsacceptrangestart(void* lpObj);
int secureblackbox_restclient_setreqparamsacceptrangestart(void* lpObj, int64 lReqParamsAcceptRangeStart);

qint64 GetReqParamsAcceptRangeStart();
int SetReqParamsAcceptRangeStart(qint64 lReqParamsAcceptRangeStart);

Default Value

0

Remarks

This property, in combination with AcceptRangeEnd, defines the media-range of the HTTP request.

This property is not available at design time.

Data Type

Long64

ReqParamsAuthorization Property (RESTClient Class)

Specifies the Authorization header of the HTTP request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsAuthorization();
int SetReqParamsAuthorization(const char* lpszReqParamsAuthorization);

Unicode (Windows)
LPWSTR GetReqParamsAuthorization();
INT SetReqParamsAuthorization(LPCWSTR lpszReqParamsAuthorization);

char* secureblackbox_restclient_getreqparamsauthorization(void* lpObj);
int secureblackbox_restclient_setreqparamsauthorization(void* lpObj, const char* lpszReqParamsAuthorization);

QString GetReqParamsAuthorization();
int SetReqParamsAuthorization(QString qsReqParamsAuthorization);

Default Value

""

Remarks

Specifies the Authorization header of the HTTP request. This header contains the credentials to authenticate a user with a server.

This property is not available at design time.

Data Type

String

ReqParamsConnection Property (RESTClient Class)

Specifies the value to pass to the Connection header property of HTTP request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsConnection();
int SetReqParamsConnection(const char* lpszReqParamsConnection);

Unicode (Windows)
LPWSTR GetReqParamsConnection();
INT SetReqParamsConnection(LPCWSTR lpszReqParamsConnection);

char* secureblackbox_restclient_getreqparamsconnection(void* lpObj);
int secureblackbox_restclient_setreqparamsconnection(void* lpObj, const char* lpszReqParamsConnection);

QString GetReqParamsConnection();
int SetReqParamsConnection(QString qsReqParamsConnection);

Default Value

""

Remarks

Specifies the value to pass to the Connection header field of HTTP request.

This property is not available at design time.

Data Type

String

ReqParamsContentLength Property (RESTClient Class)

Specifies the size of the entity-body of the HTTP request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetReqParamsContentLength();
int SetReqParamsContentLength(int64 lReqParamsContentLength);

Unicode (Windows)
LONG64 GetReqParamsContentLength();
INT SetReqParamsContentLength(LONG64 lReqParamsContentLength);

int64 secureblackbox_restclient_getreqparamscontentlength(void* lpObj);
int secureblackbox_restclient_setreqparamscontentlength(void* lpObj, int64 lReqParamsContentLength);

qint64 GetReqParamsContentLength();
int SetReqParamsContentLength(qint64 lReqParamsContentLength);

Default Value

0

Remarks

Specifies the size of the entity-body of the HTTP request. Leave this field set to 0 to make the class calculate it automatically.

This property is not available at design time.

Data Type

Long64

ReqParamsContentRangeEnd Property (RESTClient Class)

Specifies the upper bound used in the Content-Range header of the HTTP request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetReqParamsContentRangeEnd();
int SetReqParamsContentRangeEnd(int64 lReqParamsContentRangeEnd);

Unicode (Windows)
LONG64 GetReqParamsContentRangeEnd();
INT SetReqParamsContentRangeEnd(LONG64 lReqParamsContentRangeEnd);

int64 secureblackbox_restclient_getreqparamscontentrangeend(void* lpObj);
int secureblackbox_restclient_setreqparamscontentrangeend(void* lpObj, int64 lReqParamsContentRangeEnd);

qint64 GetReqParamsContentRangeEnd();
int SetReqParamsContentRangeEnd(qint64 lReqParamsContentRangeEnd);

Default Value

0

Remarks

Specifies the upper bound used in the Content-Range header of the HTTP request.

This property is not available at design time.

Data Type

Long64

ReqParamsContentRangeFullSize Property (RESTClient Class)

Specifies the total length of the full entity-body of the HTTP request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetReqParamsContentRangeFullSize();
int SetReqParamsContentRangeFullSize(int64 lReqParamsContentRangeFullSize);

Unicode (Windows)
LONG64 GetReqParamsContentRangeFullSize();
INT SetReqParamsContentRangeFullSize(LONG64 lReqParamsContentRangeFullSize);

int64 secureblackbox_restclient_getreqparamscontentrangefullsize(void* lpObj);
int secureblackbox_restclient_setreqparamscontentrangefullsize(void* lpObj, int64 lReqParamsContentRangeFullSize);

qint64 GetReqParamsContentRangeFullSize();
int SetReqParamsContentRangeFullSize(qint64 lReqParamsContentRangeFullSize);

Default Value

0

Remarks

Specifies the total length of the full entity-body of the HTTP request.

This property is not available at design time.

Data Type

Long64

ReqParamsContentRangeStart Property (RESTClient Class)

Specifies the lower bound used in the Content-Range header of the HTTP request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetReqParamsContentRangeStart();
int SetReqParamsContentRangeStart(int64 lReqParamsContentRangeStart);

Unicode (Windows)
LONG64 GetReqParamsContentRangeStart();
INT SetReqParamsContentRangeStart(LONG64 lReqParamsContentRangeStart);

int64 secureblackbox_restclient_getreqparamscontentrangestart(void* lpObj);
int secureblackbox_restclient_setreqparamscontentrangestart(void* lpObj, int64 lReqParamsContentRangeStart);

qint64 GetReqParamsContentRangeStart();
int SetReqParamsContentRangeStart(qint64 lReqParamsContentRangeStart);

Default Value

0

Remarks

Specifies the lower bound used in the Content-Range header of the HTTP request.

This property is not available at design time.

Data Type

Long64

ReqParamsContentType Property (RESTClient Class)

The Content-Type header property of the HTTP request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsContentType();
int SetReqParamsContentType(const char* lpszReqParamsContentType);

Unicode (Windows)
LPWSTR GetReqParamsContentType();
INT SetReqParamsContentType(LPCWSTR lpszReqParamsContentType);

char* secureblackbox_restclient_getreqparamscontenttype(void* lpObj);
int secureblackbox_restclient_setreqparamscontenttype(void* lpObj, const char* lpszReqParamsContentType);

QString GetReqParamsContentType();
int SetReqParamsContentType(QString qsReqParamsContentType);