LibreOffice: XAuthenticator Interface Reference

LibreOffice LibreOffice 7.3 SDK API Reference

Public Member Functions | List of all members
XAuthenticator Interface Reference

Represents an interface that will be used to query for user information which are necessary to login to a network resource. More...

`import"XAuthenticator.idl";`

Inheritance diagram for XAuthenticator:

## Public Member Functions
string | getUserName ()
| Will be called when the user name is needed. More...
string | getPassword ()
| Will be called when the password of the user is needed. More...
Public Member Functions inherited from XInterface
any | queryInterface ([in] type aType)
| queries for a new interface to an existing UNO object. More...
void | acquire ()
| increases the reference counter by one. More...
void | release ()
| decreases the reference counter by one. More...

## Detailed Description

Represents an interface that will be used to query for user information which are necessary to login to a network resource.

An implementation of this interface may for instance show a dialog to query the user for the necessary data.

Since
  OOo 2.0

## Member Function Documentation

## ◆ getPassword()

string getPassword | ( |  | ) |

Will be called when the password of the user is needed.

Returns
  the password of the user.

## ◆ getUserName()

string getUserName | ( |  | ) |

Will be called when the user name is needed.

Returns
  the user name.

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

- com/sun/star/mail/XAuthenticator.idl