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

com :: sun :: star :: security :: auth :: callback ::

interface XCallbackHandler

Base Interface
com::sun::star::uno::XInterface

Description

WARNING: this is just a draft and may be changed!

Generic callback handler interface for handling callbacks upon authentication process.


Methods' Summary

handle Handles a list of callbacks on authentication.

Methods' Details

handle
 
void
handle(
[ in ] sequence< com::sun::star::beans::XPropertySet > callbackInfos )
raises ( com::sun::star::security::auth::callback::UnsupportedCallbackException );

Description
Handles a list of callbacks on authentication.

A common string property is called CallbackType , by which additional properties describe the specific callback:

  • [ const ] CallbackType : string = &quot;Choice&quot;
    • [ const ] Prompt : string
    • [ const ] AllowMultipleSelections : boolean
    • [ const ] Choices : sequence< string >
    • [ const ] DefaultChoice : string
    • SelectedChoice : sequence< string >
  • [ const ] CallbackType : string = &quot;Confirmation&quot;
    • [ const ] Type : string [&quot;Error&quot; | &quot;Information&quot; | &quot;Warning&quot;]
    • [ const ] Prompt : string
    • [ const ] Options : string (e.g., &quot;Yes,No&quot;)
    • [ const ] DefaultOption : string
    • SelectedOption : string
  • [ const ] CallbackType : string = &quot;Language&quot;
    • [ const ] Locale : string
  • [ const ] CallbackType : string = &quot;Password&quot;
    • [ const ] Prompt : string
    • [ const ] EchoOn : boolean
    • Password : string
  • [ const ] CallbackType : string = &quot;TextInput&quot;
    • [ const ] Prompt : string
    • [ const ] Default : string
    • Input : string
  • [ const ] CallbackType : string = &quot;TextOutput&quot;
    • [ const ] Type : string [&quot;Error&quot; | &quot;Information&quot; | &quot;Warning&quot;]
    • [ const ] Message : string

Parameter callbackInfos
list of callbacks to be handled
Throws
UnsupportedCallbackException if callback could not be handled

Top of Page