Foxit PDF SDK
fsdk.SOAPAuthenticateInfo Class Reference

Public Member Functions

def GetIs_use_platform_auth ()
 Get a Boolean value indicating that platform authentication should be used. More...
 
def GetPassword ()
 Get a string containing the password to use for authentication. More...
 
def GetUsername ()
 Get a string containing the user name to use for authentication. More...
 
def Set (username, password, is_use_platform_auth)
 Set values.
More...
 
def SetIs_use_platform_auth (value)
 Set a Boolean value indicating that platform authentication should be used. More...
 
def SetPassword (value)
 Set a string containing the password to use for authentication. More...
 
def SetUsername (value)
 Set a string containing the user name to use for authentication. More...
 

Detailed Description

This class represents SOAP authenticate.

Member Function Documentation

◆ GetIs_use_platform_auth()

fsdk.SOAPAuthenticateInfo.GetIs_use_platform_auth ( )

Get 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.

Returns
A Boolean value indicating that platform authentication should be used.

◆ GetPassword()

fsdk.SOAPAuthenticateInfo.GetPassword ( )

Get a string containing the password to use for authentication.

Returns
A string containing the password to use for authentication.

◆ GetUsername()

fsdk.SOAPAuthenticateInfo.GetUsername ( )

Get a string containing the user name to use for authentication.

Returns
A string containing the user name to use for authentication.

◆ Set()

def fsdk.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.

◆ SetIs_use_platform_auth()

fsdk.SOAPAuthenticateInfo.SetIs_use_platform_auth (   value)

Set 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.

Parameters
[in]valueA Boolean value indicating that platform authentication should be used.
Returns
None.

◆ SetPassword()

fsdk.SOAPAuthenticateInfo.SetPassword (   value)

Set a string containing the password to use for authentication.

Parameters
[in]valueA string containing the password to use for authentication.
Returns
None.

◆ SetUsername()

fsdk.SOAPAuthenticateInfo.SetUsername (   value)

Set a string containing the user name to use for authentication.

Parameters
[in]valueA string containing the user name to use for authentication.
Returns
None.