Files
mostlymatter/e2e-tests/cypress/tests/support/ui/channel_header.d.ts
2023-03-28 18:10:00 +02:00

87 строки
2.4 KiB
TypeScript

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
/// <reference types="cypress" />
// ***************************************************************
// Each command should be properly documented using JSDoc.
// See https://jsdoc.app/index.html for reference.
// Basic requirements for documentation are the following:
// - Meaningful description
// - Each parameter with `@params`
// - Return value with `@returns`
// - Example usage with `@example`
// Custom command should follow naming convention of having `ui` prefix, e.g. `uiGetChannelFavoriteButton`.
// ***************************************************************
declare namespace Cypress {
interface Chainable {
/**
* Get channel header button.
*
* @example
* cy.uiGetChannelHeaderButton().click();
*/
uiGetChannelHeaderButton(): Chainable;
/**
* Get favorite button from channel header.
*
* @example
* cy.uiGetChannelFavoriteButton().click();
*/
uiGetChannelFavoriteButton(): Chainable;
/**
* Get mute button from channel header.
*
* @example
* cy.uiGetMuteButton().click();
*/
uiGetMuteButton(): Chainable;
/**
* Get member button from channel header.
*
* @example
* cy.uiGetChannelMemberButton().click();
*/
uiGetChannelMemberButton(): Chainable;
/**
* Get pin button from channel header.
*
* @example
* cy.uiGetChannelPinButton().click();
*/
uiGetChannelPinButton(): Chainable;
/**
* Get files button from channel header.
*
* @example
* cy.uiGetChannelFileButton().click();
*/
uiGetChannelFileButton(): Chainable;
/**
* Get channel menu
*
* @example
* cy.uiGetChannelMenu();
*/
uiGetChannelMenu(): Chainable;
/**
* Open channel menu
* @param {string} [menu] - such as `'View Info'`, `'Notification Preferences'`, `'Team Settings'` and other items in the main menu.
* @return the channel menu
*
* @example
* cy.uiOpenChannelMenu();
*/
uiOpenChannelMenu(menu?: string): Chainable;
}
}