blpapi::AuthOptions Class Reference

#include <blpapi_authoptions.h>

List of all members.

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 ()
AuthOptions &	operator= (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

blpapi::AuthOptions::AuthOptions

(

)

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

blpapi::AuthOptions::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().

blpapi::AuthOptions::AuthOptions

(

const AuthApplication &

app

)

Create an AuthOptions object for Application Mode.

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

Create an AuthOptions object for User and Application Mode.

blpapi::AuthOptions::AuthOptions

(

const AuthToken &

token

)

Create an AuthOptions object for Manual Token Mode.

blpapi::AuthOptions::AuthOptions

(

blpapi_AuthOptions_t *

handle

)

[explicit]

For internal use only.

blpapi::AuthOptions::AuthOptions

(

const AuthOptions &

options

)

Copy constructor.

blpapi::AuthOptions::~AuthOptions

(

)

Destructor.

---

Member Function Documentation

AuthOptions& blpapi::AuthOptions::operator=

(

const AuthOptions &

rhs

)

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

blpapi_AuthOptions_t* blpapi::AuthOptions::handle

(

)

const

For internal use only.

---

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

• blpapi_authoptions.h