PopupEventArgs class
Arguments for a popup event if interaction is required during the login flow.
- Extends
Constructors
| (constructor)(cancel, request |
Constructs a new instance of the |
Properties
| cancel | A handler should call this immediately when handling the event to signal that it will not permit a popup. |
| options | |
| request |
A handler should call this immediately when handling the event to signal that it intends to show a popup. |
| resource | |
| show |
A handler should call this when ready, to indicate that the login flow should now continue and launch the popup. |
Constructor Details
(constructor)(cancel, requestPopup, showPopup, resource, options)
Constructs a new instance of the PopupEventArgs class
constructor(cancel: (error?: Error) => void, requestPopup: () => void, showPopup: () => Promise<void> | void, resource: string, options: IGetTokenDataOptions);Parameters
- cancel
-
(error?: Error) => void
- requestPopup
-
() => void
- showPopup
-
() => Promise<void> | void
- resource
-
string
- options
- @microsoft/sp-http-base!~IGetTokenDataOptions:interface
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
options: IGetTokenDataOptions;Property Value
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
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