import ContactsController from 'automation.client.ui/src/controllers/web/contacts.controller.js'

public class | source

ContactsController

Extends:

BaseController → ContactsController

Controller for making and handling calls

Constructor Summary

Public Constructor
public	constructor(args: args)

Member Summary

Public Members
public	baseContactFormPage: *
public	baseModalPage: *
public	contactDetailsPanel: *
public	contactsPage: *
public	createContactModal: *
public	createMeetingModal: *
public	deleteModal: *
public	headerPanel: *
public	meetingDetailsPanel: *
public	meetingsPage: *
public	personalContactDetailsPanel: *
public	roomSystemDetailsPanel: *
public	roomSystemsPage: *

Method Summary

Public Methods
public	async checkCallingDetailsFieldLimit(expectedLimit: Integer): Boolean Checks calling details field limit and returns a boolean value
public	async checkContactCallingDetailsFieldError(expectedError: String): Boolean Checks for error message and exclamation for the calling details field in contact create/edit form
public	async checkContactFormNameFieldError(expectedError: String): Boolean Checks for error message and exclamation for the name field (Applicable to both contact and meeting create/edit modal)
public	async checkFormHeader(expectedHeader: String): Boolean Checks for the form header to be the expected string
public	async checkNameFieldLimit(expectedLimit: String): Boolean Checks name field limit and returns a boolean value
public	async clickContactFormCancelButton() Clicks on contact form cancel button
public	async closeModal() Closes the create/edit contact form (Applicable to contact and meeting create/edit/delete modal)
public	async createMeeting(name: String, options: Object) Creates a meeting
public	async createPersonalContact(name: String, details: String, options: Object) Creates a personal contact
public	async deletePersonalContact(name: String, confirmDelete: Boolean) Deletes a personal contact
public	async editPersonalContact(name: String, newData: Object) Edits a personal contact
public	async getContactDetails(name: String): Object Looks for the contact in the contacts list and get contact details
public	async getContactNamesInList(): Array Get the names of the contact list
public	async getMeetingNamesInList(): Array Get the names of the meeting list
public	async getNoContactsMessage(): String Get the text of the no contacts match message
public	async getNoMeetingsMessage(): String Get the text of the no contacts match message
public	async getNoRoomsMessage(): String Get the text of the no contacts match message
public	async getPersonalContactDetails(name: String): Object Looks for a personal contact in the contacts list and get contact details
public	async getRoomNamesInList(): Array Get the names of the room list
public	async isContactChattable(contact: String): Boolean Determines if Contacts are Chattable
public	async isContactFormHeaderVisible(): Boolean Returns if contact form header is visible
public	async isContactFormSaveButtonEnabled(): Boolean Checks if save button is enabled
public	async isContactInList(name: String): Boolean Fills form with provided parameters and saves contact
public	async isFieldErrorsVisible(): Boolean Checks to see either the name or calling details field has an error
public	async openCreateContactForm() Opens contact creation form
public	async openCreateMeetingForm() Open meeting creation form
public	async openDeleteContactModal(name: String) Opens delete contact modal
public	async openEditContactForm(name: String) Looks for a contact in contact list and opens the edit contact form

Inherited Summary

From class BaseController
public	browser: *
public	testName: *

Public Constructors

public constructor(args: args) source

Each controller needs a browser. Page objects use this browser, and is ultimately used there to make calls to the actual browser.

Override:

BaseController#constructor

Params:

Name	Type	Attribute	Description
args	args		Args from client

Public Members

public baseContactFormPage: * source

public baseModalPage: * source

public contactDetailsPanel: * source

public contactsPage: * source

public createContactModal: * source

public createMeetingModal: * source

public deleteModal: * source

public headerPanel: * source

public meetingDetailsPanel: * source

public meetingsPage: * source

public personalContactDetailsPanel: * source

public roomSystemDetailsPanel: * source

public roomSystemsPage: * source

Public Methods

public async checkCallingDetailsFieldLimit(expectedLimit: Integer): Boolean source

Checks calling details field limit and returns a boolean value

Params:

Name	Type	Attribute	Description
expectedLimit	Integer		Expected field limit

Return:

Boolean

Returns true if expected and actual is same else false

public async checkContactCallingDetailsFieldError(expectedError: String): Boolean source

Checks for error message and exclamation for the calling details field in contact create/edit form

Params:

Name	Type	Attribute	Description
expectedError	String		Expected error message

Return:

Boolean

Returns true if error is present

public async checkContactFormNameFieldError(expectedError: String): Boolean source

Checks for error message and exclamation for the name field (Applicable to both contact and meeting create/edit modal)

Params:

Name	Type	Attribute	Description
expectedError	String		Expected error message

Return:

Boolean

Returns true if error is present

public async checkFormHeader(expectedHeader: String): Boolean source

Checks for the form header to be the expected string

Params:

Name	Type	Attribute	Description
expectedHeader	String		Expected form header

Return:

Boolean

Whether the expected form header is same as the actual

public async checkNameFieldLimit(expectedLimit: String): Boolean source

Checks name field limit and returns a boolean value

Params:

Name	Type	Attribute	Description
expectedLimit	String		Expected field limit

Return:

Boolean

Returns true if expected and actual is same else false

public async clickContactFormCancelButton() source

Clicks on contact form cancel button

public async closeModal() source

Closes the create/edit contact form (Applicable to contact and meeting create/edit/delete modal)

public async createMeeting(name: String, options: Object) source

Creates a meeting

Params:

Name	Type	Attribute	Description
name	String		Contact name
options	Object		Favorite as boolean, or doNotSubmit as boolean

public async createPersonalContact(name: String, details: String, options: Object) source

Creates a personal contact

Params:

Name	Type	Attribute	Description
name	String		Contact name
details	String		Contact details
options	Object		Favorite as boolean, or doNotSubmit as boolean

public async deletePersonalContact(name: String, confirmDelete: Boolean) source

Deletes a personal contact

Params:

Name	Type	Attribute	Description
name	String		Name of the contact to be deleted
confirmDelete	Boolean		Confirms deletion on true else cancels it

public async editPersonalContact(name: String, newData: Object) source

Edits a personal contact

Params:

Name	Type	Attribute	Description
name	String		Name of the contact to be edited
newData	Object		Object with new name, callingDetails and favorite

public async getContactDetails(name: String): Object source

Looks for the contact in the contacts list and get contact details

Params:

Name	Type	Attribute	Description
name	String		Name of the contact to look for

Return:

Object

Details of the contact

public async getContactNamesInList(): Array source

Get the names of the contact list

Return:

Array

Array of names

public async getMeetingNamesInList(): Array source

Get the names of the meeting list

Return:

Array

Array of names

public async getNoContactsMessage(): String source

Get the text of the no contacts match message

Return:

String

Text of the message

public async getNoMeetingsMessage(): String source

Get the text of the no contacts match message

Return:

String

Text of the message

public async getNoRoomsMessage(): String source

Get the text of the no contacts match message

Return:

String

Text of the message

public async getPersonalContactDetails(name: String): Object source

Looks for a personal contact in the contacts list and get contact details

Params:

Name	Type	Attribute	Description
name	String		Name of the personal contact to look for

Return:

Object

Details of personal contact

public async getRoomNamesInList(): Array source

Get the names of the room list

Return:

Array

Array of names

public async isContactChattable(contact: String): Boolean source

Determines if Contacts are Chattable

Params:

Name	Type	Attribute	Description
contact	String		Name of Contact

Return:

Boolean

True if Chattable and False if Not

public async isContactFormHeaderVisible(): Boolean source

Returns if contact form header is visible

Return:

Boolean

True if contact form header is visible

public async isContactFormSaveButtonEnabled(): Boolean source

Checks if save button is enabled

Return:

Boolean

True if button is enabled

public async isContactInList(name: String): Boolean source

Fills form with provided parameters and saves contact

Params:

Name	Type	Attribute	Description
name	String		Name of contact

Return:

Boolean

true if contact is found in list, false if not

public async isFieldErrorsVisible(): Boolean source

Checks to see either the name or calling details field has an error

Return:

Boolean

True if error is visible

public async openCreateContactForm() source

Opens contact creation form

public async openCreateMeetingForm() source

Open meeting creation form

public async openDeleteContactModal(name: String) source

Opens delete contact modal

Params:

Name	Type	Attribute	Description
name	String		Name of the contact

public async openEditContactForm(name: String) source

Looks for a contact in contact list and opens the edit contact form

Params:

Name	Type	Attribute	Description
name	String		Name of contact to edit