Edit

Share via


IPopupEventArgs interface

Represents arguments used before popup event.

Extends

Properties

cancel

A handler should call this immediately when handling the event to signal that it will not permit a popup.

options

The options used for the call which is triggering the popup.

requestPopup

A handler should call this immediately when handling the event to signal that it intends to show a popup.

resource

The resource being requested.

showPopup

A handler should call this when ready, to indicate that the login flow should now continue and launch the popup.

Property Details

cancel

A handler should call this immediately when handling the event to signal that it will not permit a popup.

cancel: (error?: Error) => void;

Property Value

(error?: Error) => void

options

The options used for the call which is triggering the popup.

options: IGetTokenDataOptions;

Property Value

@microsoft/sp-http-base!~IGetTokenDataOptions:interface

requestPopup

A handler should call this immediately when handling the event to signal that it intends to show a popup.

requestPopup: () => void;

Property Value

() => void

resource

The resource being requested.

resource: string;

Property Value

string

showPopup

A handler should call this when ready, to indicate that the login flow should now continue and launch the popup.

showPopup: () => Promise<void> | void;

Property Value

() => Promise<void> | void