Foxit PDF SDK  9.1
FSSOAPAuthenticateInfo Class Reference

If set, that means to get the endpoint of a path.
More...

Inheritance diagram for FSSOAPAuthenticateInfo:

Instance Methods

(void) - dealloc
 
(void *) - getCptr
 
(id) - init
 Constructor.
More...
 
(id) - initWithCptr:swigOwnCObject:
 
(id) - initWithSoap_authenticate:
 Constructor, with another SOAP authenticate object.
More...
 
(id) - initWithUsername:password:is_use_platform_auth:
 Constructor, with parameters.
More...
 
(void) - set:password:is_use_platform_auth:
 Set values.
More...
 

Protected Attributes

BOOL swigCMemOwn
 
void * swigCPtr
 

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.
More...
 
NSString * username
 A string containing the user name to use for authentication.
More...
 

Detailed Description

If set, that means to get the endpoint of a path.

If set, that means to get the midpoint for two endpoints of a path.

If set, that means to get the intersection of two intersecting paths.

If set, that means to get the nearest point (which is in a path) to the specified point.

This class represents SOAP authenticate.

Method Documentation

◆ dealloc

- (void) dealloc

◆ getCptr

- (void*) getCptr

◆ init

- (id) init

Constructor.

◆ initWithCptr:swigOwnCObject:

- (id) initWithCptr: (void *)  cptr
swigOwnCObject: (BOOL)  ownCObject 

◆ initWithSoap_authenticate:

- (id) initWithSoap_authenticate: (FSSOAPAuthenticateInfo*)  soap_authenticate

Constructor, with another SOAP authenticate object.

Parameters
[in]soap_authenticateAnother SOAP authenticate object.

◆ initWithUsername:password:is_use_platform_auth:

- (id) initWithUsername: (NSString *)  username
password: (NSString *)  password
is_use_platform_auth: (BOOL)  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: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]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

◆ swigCMemOwn

- (BOOL) swigCMemOwn
protected

◆ swigCPtr

- (void*) swigCPtr
protected

Property Documentation

◆ is_use_platform_auth

- (BOOL) is_use_platform_auth
readwritenonatomicassign

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.

◆ password

- (NSString *) password
readwritenonatomiccopy

A string containing the password to use for authentication.

◆ username

- (NSString *) username
readwritenonatomiccopy

A string containing the user name to use for authentication.