Foxit PDF SDK
FSDK.SOAPAuthenticateInfo Class Reference

Public Member Functions

 constructor ()
 Constructor.
 
 constructor (username, password, is_use_platform_auth)
 Constructor, with parameters. More...
 
 Set (username, password, is_use_platform_auth)
 Set values. More...
 

Public Attributes

 is_use_platform_auth
 A Boolean value indicating that platform authentication should be used. More...
 
 password
 A string containing the password to use for authentication.
 
 username
 A string containing the user name to use for authentication.
 

Detailed Description

This class represents SOAP authenticate.

Member Function Documentation

◆ constructor()

FSDK.SOAPAuthenticateInfo.constructor ( username  ,
password  ,
is_use_platform_auth   
)

Constructor, with parameters.

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.

◆ Set()

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.

Member Data Documentation

◆ is_use_platform_auth

FSDK.SOAPAuthenticateInfo.is_use_platform_auth

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.