Foxit PDF SDK
FoxitPDFSDKPython2.SOAPAuthenticateInfo Class Reference

Inherits FoxitPDFSDKPython2._object.

Public Member Functions

def SOAPAuthenticateInfo ()
 Constructor.
More...
 
def Set (username, password, is_use_platform_auth)
 Set values.
More...
 

Static Public Attributes

 is_use_platform_auth = _swig_property(_fsdk.SOAPAuthenticateInfo_is_use_platform_auth_get, _fsdk.SOAPAuthenticateInfo_is_use_platform_auth_set)
 A Boolean value indicating that platform authentication should be used.
More...
 
 password = _swig_property(_fsdk.SOAPAuthenticateInfo_password_get, _fsdk.SOAPAuthenticateInfo_password_set)
 A string containing the password to use for authentication.

 
 username = _swig_property(_fsdk.SOAPAuthenticateInfo_username_get, _fsdk.SOAPAuthenticateInfo_username_set)
 A string containing the user name to use for authentication.

 

Detailed Description

This class represents SOAP authenticate.

Constructor & Destructor Documentation

◆ SOAPAuthenticateInfo()

def FoxitPDFSDKPython2.SOAPAuthenticateInfo.SOAPAuthenticateInfo ( )

Constructor.

Constructor, with parameters.

Constructor, with another SOAP authenticate object.

Parameters
[in]soap_authenticateAnother SOAP authenticate object.
[in]usernameA string containing the user name to use for authentication.
[in]passwordA string containing the password to use for authentication.
[in]is_use_platform_authA Boolean value indicating that platform authentication should be used.

Member Function Documentation

◆ Set()

def FoxitPDFSDKPython2.SOAPAuthenticateInfo.Set (   username,
  password,
  is_use_platform_auth 
)

Set values.

Parameters
[in]usernameA string containing the user name to use for authentication.
[in]passwordA string containing the password to use for authentication.
[in]is_use_platform_authA Boolean value indicating that platform authentication should be used.

Returns
None.

Member Data Documentation

◆ is_use_platform_auth

FoxitPDFSDKPython2.SOAPAuthenticateInfo.is_use_platform_auth = _swig_property(_fsdk.SOAPAuthenticateInfo_is_use_platform_auth_get, _fsdk.SOAPAuthenticateInfo_is_use_platform_auth_set)
static

A Boolean value indicating that platform authentication should be used.

If true, username and password are ignored and the underlying platform networking code is used.This may cause an authentication UI to be shown to the user and/or the credentials of the currently logged in user to be used. The default is false and is only supported on the Windows platform.