Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: ucb ::

interface XInteractionSupplyAuthentication

Base Interface
com::sun::star::task::XInteractionContinuation

Description
An interaction continuation handing back some authentication data.

This continuation is typically used in conjunction with AuthenticationRequest .



Methods' Summary

canSetRealm Specifies if a new 'realm' value can be handed back.
setRealm Set a new 'realm' value to hand back.
canSetUserName Specifies if a 'user name' value can be handed back.
setUserName Set a new 'user name' value to hand back.
canSetPassword Specifies if a 'password' value can be handed back.
setPassword Set a new 'password' value to hand back.
getRememberPasswordModes Specifies the available modes of how long to remember the password.
setRememberPassword Set a new mode of how long to remember the password.
canSetAccount Specifies if an 'account' value can be handed back.
setAccount Set a new 'account' value to hand back.
getRememberAccountModes Specifies the available modes of how long to remember the account.
setRememberAccount Set a new mode of how long to remember the account.

Methods' Details

canSetRealm
 
boolean
canSetRealm();
Description
Specifies if a new 'realm' value can be handed back.
setRealm
 
void
setRealm(
[ in ] string Realm );

Description
Set a new 'realm' value to hand back.

This method should be called before XInteractionContinuation::select , and should only be called if XInteractionSupplyAuthentication::canSetRealm returned true .

canSetUserName
 
boolean
canSetUserName();
Description
Specifies if a 'user name' value can be handed back.
setUserName
 
void
setUserName(
[ in ] string UserName );

Description
Set a new 'user name' value to hand back.

This method should be called before XInteractionContinuation::select , and should only be called if XInteractionSupplyAuthentication::canSetUserName returned true .

canSetPassword
 
boolean
canSetPassword();
Description
Specifies if a 'password' value can be handed back.
setPassword
 
void
setPassword(
[ in ] string Password );

Description
Set a new 'password' value to hand back.

This method should be called before XInteractionContinuation::select , and should only be called if XInteractionSupplyAuthentication::canSetPassword returned true .

getRememberPasswordModes
 
sequence< com::sun::star::ucb::RememberAuthentication >
getRememberPasswordModes(
[ out ] com::sun::star::ucb::RememberAuthentication Default );

Description
Specifies the available modes of how long to remember the password.
Parameter Default
Returns the default mode (to be initially displayed to the user).
Returns
A sequence of available modes to hand back. Each individual mode should appear at most once in the sequence. If the sequence is empty, a new mode cannot be handed back.
setRememberPassword
 
void
setRememberPassword(
[ in ] com::sun::star::ucb::RememberAuthentication Remember );

Description
Set a new mode of how long to remember the password.

This method should be called before XInteractionContinuation::select , and should only be called if XInteractionSupplyAuthentication::setPassword is also called.

Parameter Remember
The mode to hand back, should be contained in the sequence returned by XInteractionSupplyAuthentication::getRememberPasswordModes .
canSetAccount
 
boolean
canSetAccount();
Description
Specifies if an 'account' value can be handed back.
setAccount
 
void
setAccount(
[ in ] string Account );

Description
Set a new 'account' value to hand back.

This method should be called before XInteractionContinuation::select , and should only be called if XInteractionSupplyAuthentication::canSetAccount returned true .

getRememberAccountModes
 
sequence< com::sun::star::ucb::RememberAuthentication >
getRememberAccountModes(
[ out ] com::sun::star::ucb::RememberAuthentication Default );

Description
Specifies the available modes of how long to remember the account.
Parameter Default
Returns the default mode (to be initially displayed to the user).
Returns
A sequence of available modes to hand back. Each individual mode should appear at most once in the sequence. If the sequence is empty, a new mode cannot be handed back.
setRememberAccount
 
void
setRememberAccount(
[ in ] com::sun::star::ucb::RememberAuthentication Remember );

Description
Set a new mode of how long to remember the account.

This method should be called before XInteractionContinuation::select , and should only be called if XInteractionSupplyAuthentication::setAccount is also called.

Parameter Remember
The mode to hand back, should be contained in the sequence returned by XInteractionSupplyAuthentication::getRememberAccountModes .

Top of Page