Class SignInWithMicrosoftForm

A model for the Microsoft sign-in form

Hierarchy (View Summary)

ComponentModel
- SignInWithMicrosoftForm

Index

Constructors

Properties

errorMessage root xpath

Methods

authenticate getChildOfType getGlobalLocator getLocator

Constructors

constructor

new SignInWithMicrosoftForm(page: Page): SignInWithMicrosoftForm
Parameters
- page: Page
Returns SignInWithMicrosoftForm
Overrides ComponentModel.constructor

Properties

`Readonly`errorMessage

errorMessage: Locator = ...

A locator to a message displayed on authentication failure.

`Protected`root

root: Page | FrameLocator

The root playwright entity from which to resolve this component model's xpath.

`Readonly`xpath

xpath: string

An absolute xpath to the DOM element that this component model represents.

Methods

authenticate

authenticate(credentials: { password: string; username: string }): Promise<void>
This method signs in with microsoft. The Microsoft sign-in form must be displayed before using this method. Authentication failure due to bad credentials will result in an exception.

The following steps will be taken:
- Enter email and click 'Next'
- Enter the password and click 'Sign in'
- Click 'Accept' if 'Accept Permissions' page is displayed. Otherwise click 'Yes' if 'Stay Signed In' page is displayed
- Wait for the form to be detached
Parameters
- credentials: { password: string; username: string }
Returns Promise<void>

getChildOfType

getChildOfType<TModel extends ComponentModel>(
    model: ComponentModelType<TModel>,
    xpath?: string,
    nth?: number,
): TModel
This method gets a child component model with a provided type. This is useful for modelling a page where the UI is composed in a custom manner.
Type Parameters
- TModel extends ComponentModel
Parameters
- model: ComponentModelType<TModel>
  A ComponentModel type. e.g. ToggleButton / Modal
- Optionalxpath: string
  An optional xpath relative to this component. If not provided, the model's default xpath will be used.
- Optionalnth: number
  Optional position among matches. Position is 1 indexed. Negative numbers count from the end.
Returns TModel
Inherited from ComponentModel.getChildOfType

`Protected`getGlobalLocator

getGlobalLocator(selector: string): Locator
A helper method to create global locators - This helps with locating globally across the entire DOM, rather than being scoped to the form
Parameters
- selector: string
Returns Locator
Inherited from ComponentModel.getGlobalLocator

getLocator

getLocator(): Locator
This method gets a locator to the DOM element represented by this component model.

Returns Locator
Inherited from ComponentModel.getLocator
getLocator(xpath: string, nth?: number): Locator
This method gets a locator to a DOM element relative to the element represented by this component model.
Parameters
- xpath: string
  An xpath relative to this component.
- Optionalnth: number
  Optional position among matches. Position is 1 indexed. Negative numbers count from the end.
Returns Locator
Inherited from ComponentModel.getLocator