BLPAPI C++ 3.26.5
Loading...
Searching...
No Matches
AuthOptions Class Reference

#include <blpapi_authoptions.h>

Public Member Functions

 AuthOptions ()
 AuthOptions (const AuthUser &user)
 AuthOptions (const AuthApplication &app)
 AuthOptions (const AuthUser &user, const AuthApplication &app)
 AuthOptions (const AuthToken &token)
 AuthOptions (blpapi_AuthOptions_t *handle)
 AuthOptions (const AuthOptions &options)
 ~AuthOptions ()
AuthOptionsoperator= (const AuthOptions &rhs)
blpapi_AuthOptions_t * handle () const

Detailed Description

Contains the authorization options which the user can set on SessionOptions as the authorization options for the session identity or use to authorize other Identitys.

See Component blpapi_authoptions

Constructor & Destructor Documentation

◆ AuthOptions() [1/7]

Create an AuthOptions object to specify no authorization should be used.

◆ AuthOptions() [2/7]

AuthOptions ( const AuthUser & user)

Create an AuthOptions object for User Mode with Operating System Login (Domain\User), Active Directory, or Email.

The behavior is undefined when user was created with AuthUser::createWithManualOptions().

◆ AuthOptions() [3/7]

AuthOptions ( const AuthApplication & app)

Create an AuthOptions object for Application Mode.

◆ AuthOptions() [4/7]

AuthOptions ( const AuthUser & user,
const AuthApplication & app )

Create an AuthOptions object for User and Application Mode.

◆ AuthOptions() [5/7]

AuthOptions ( const AuthToken & token)

Create an AuthOptions object for Manual Token Mode.

◆ AuthOptions() [6/7]

AuthOptions ( blpapi_AuthOptions_t * handle)
explicit

For internal use only.

◆ AuthOptions() [7/7]

AuthOptions ( const AuthOptions & options)

Copy constructor.

◆ ~AuthOptions()

Destructor.

Member Function Documentation

◆ handle()

blpapi_AuthOptions_t * handle ( ) const

For internal use only.

◆ operator=()

AuthOptions & operator= ( const AuthOptions & rhs)

Assign to this object the value of the specified rhs object.


The documentation for this class was generated from the following file: