Foxit PDF SDK

Instance Methods | Properties | List of all members
FSSOAPAuthenticateInfo Class Reference

Inherits NSObject.

## Instance Methods
(id) | - init
| Constructor.
(id) | - initWithSoap_authenticate:
| Constructor, with another SOAP authenticate object. More...
(void) | - set:password:is_use_platform_auth:
| Set values. More...

## Properties
BOOL | is_use_platform_auth
| A Boolean value indicating that platform authentication should be used. More...
NSString * | password
| A string containing the password to use for authentication.
NSString * | username
| A string containing the user name to use for authentication.

## Detailed Description

This class represents SOAP authenticate.

## Method Documentation

## ◆ initWithSoap_authenticate:()

- (id) initWithSoap_authenticate: |  | (FSSOAPAuthenticateInfo*) | soap_authenticate |

Constructor, with another SOAP authenticate object.

Parameters

  [in] | soap_authenticate | Another SOAP authenticate object.

## ◆ set:password:is_use_platform_auth:()

- (void) set: |  | (NSString *) | username
password: |  | (NSString *) | password
is_use_platform_auth: |  | (BOOL) | is_use_platform_auth

Set values.

Parameters

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

Returns
  None.

## Property Documentation

## ◆ is_use_platform_auth

- (BOOL) is_use_platform_auth
| read write nonatomic assign

A Boolean value indicating that platform authentication should be used.

If YES, 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 NO and is only supported on the Windows platform.