EMA C++ Edition
List of all members
refinitiv::ema::access::LoginMsgCredentialRenewal Class Reference

LoginMsgCredentialRenewal class is used with OmmConsumer::SubmitOAuthCredentialRenewal to supply EMA with changed credentials. More...

Public Member Functions

Constructor
 LoginMsgCredentialRenewal ()
  More...
 
Destructor
 ~LoginMsgCredentialRenewal ()
  More...
 
Operations
LoginMsgCredentialRenewalclear ()
  More...
 
LoginMsgCredentialRenewaluserName (EmaString &userName)
  More...
 
LoginMsgCredentialRenewalauthenticationExtended (EmaBuffer &authenticationExtended)
  More...
 

Accessors

const EmaStringgetUserName ()
  More...
 
const EmaBuffergetAuthenticationExtended ()
  More...
 

Detailed Description

Definition at line 33 of file LoginMsgCredentialRenewal.h.

Constructor & Destructor Documentation

◆ LoginMsgCredentialRenewal()

refinitiv::ema::access::LoginMsgCredentialRenewal::LoginMsgCredentialRenewal ( )

Create an LoginMsgCredentialRenewal for use with OmmConsumer::SubmitOAuthCredentialRenewal

◆ ~LoginMsgCredentialRenewal()

refinitiv::ema::access::LoginMsgCredentialRenewal::~LoginMsgCredentialRenewal ( )

Clear out all contained EmaString by zeroing out the memory, then free everything.

Member Function Documentation

◆ authenticationExtended()

LoginMsgCredentialRenewal& refinitiv::ema::access::LoginMsgCredentialRenewal::authenticationExtended ( EmaBuffer authenticationExtended)

Specifies the extended authentication information that will be updated.

Parameters
[in]userNamespecifies the user name for oAuth2 interactions.
Returns
reference to this object

◆ clear()

LoginMsgCredentialRenewal& refinitiv::ema::access::LoginMsgCredentialRenewal::clear ( )

Zeros out and clears all allocated EMAStrings in the class.

Returns
reference to this object

◆ getAuthenticationExtended()

const EmaBuffer& refinitiv::ema::access::LoginMsgCredentialRenewal::getAuthenticationExtended ( )

Gets the authentication extended buffer.

Returns
authentication extended

◆ getUserName()

const EmaString& refinitiv::ema::access::LoginMsgCredentialRenewal::getUserName ( )

Gets the user name.

Returns
user name

◆ userName()

LoginMsgCredentialRenewal& refinitiv::ema::access::LoginMsgCredentialRenewal::userName ( EmaString userName)

Specifies the user name that will be updated.

Parameters
[in]userNamespecifies the new user name for this login.
Returns
reference to this object