interface XCallbackHandler in module com::sun::star::security::auth::callback::

(Global Index)

Syntax

interface XCallbackHandler : 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.

Method Summary

handle Handles a list of callbacks on authentication.

Method Details



handle

Syntax

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

Parameter callbackInfos

list of callbacks to be handled

Throws

UnsupportedCallbackException if callback could not be handled
Top of Page