interface XInteractionSupplyAuthentication in module com::sun::star::ucb::

(Global Index)

Syntax

interface XInteractionSupplyAuthentication : com::sun::star::task::XInteractionContinuation ;

Description

An interaction continuation handing back some authentication data.

This continuation is typically used in conjunction with AuthenticationRequest .

Method 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.

Method Details



canSetRealm

Syntax

boolean canSetRealm ();

Description

Specifies if a new 'realm' value can be handed back.


setRealm

Syntax

void setRealm (
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

Syntax

boolean canSetUserName ();

Description

Specifies if a 'user name' value can be handed back.


setUserName

Syntax

void setUserName (
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

Syntax

boolean canSetPassword ();

Description

Specifies if a 'password' value can be handed back.


setPassword

Syntax

void setPassword (
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

Syntax

sequence< com::sun::star::ucb::RememberAuthentication > getRememberPasswordModes (
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

Syntax

void setRememberPassword (
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

Syntax

boolean canSetAccount ();

Description

Specifies if an 'account' value can be handed back.


setAccount

Syntax

void setAccount (
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

Syntax

sequence< com::sun::star::ucb::RememberAuthentication > getRememberAccountModes (
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

Syntax

void setRememberAccount (
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