WiFiConnectParam Class Reference

Class that stores a custom parameter. More...

#include <WiFiConnectParam.h>

Public Member Functions
	WiFiConnectParam (const char *custom)
	Class object initialiser. More...
	WiFiConnectParam (const char *id, const char *placeholder, const char *defaultValue, int length)
	Class object initialiser. More...
	WiFiConnectParam (const char *id, const char *placeholder, const char *defaultValue, int length, const char *custom)
	Class object initialiser. More...
const char *	getID ()
	Function to get the current id of the item. More...
const char *	getValue ()
	Function to get the current value of the item. More...
const char *	getPlaceholder ()
	Function to get the current placeholder text of the item. More...
int	getValueLength ()
	Function to get the maximum length allowed for the value of the item. More...
const char *	getCustomHTML ()
	Function to get the current custom html markup of the item. More...
void	setValue (const char *newValue)
	Method to change the current value of the item. More...

Friends
class	WiFiConnect
	Declarion for WiFiConnect class.

Detailed Description

Class that stores a custom parameter.

Constructor & Destructor Documentation

WiFiConnectParam() [1/3]

WiFiConnectParam::WiFiConnectParam

(

const char *

custom

)

Class object initialiser.

Parameters

custom

Custom HTML to be displayed in the access point for this item.

WiFiConnectParam() [2/3]

WiFiConnectParam::WiFiConnectParam	(	const char *	id,
		const char *	placeholder,
		const char *	defaultValue,
		int	length
	)

Class object initialiser.

Parameters

id	The unique ID for the html input box markup for this item
placeholder	Text to be displayed as the input box placeholder for this item
defaultValue	Default text to be displayed in the input box for this item
length	The maximum input text length for this item

WiFiConnectParam() [3/3]

WiFiConnectParam::WiFiConnectParam	(	const char *	id,
		const char *	placeholder,
		const char *	defaultValue,
		int	length,
		const char *	custom
	)

Class object initialiser.

Parameters

id	The unique ID for the html input box markup for this item
placeholder	Text to be displayed as the input box placeholder for this item
defaultValue	Default text to be displayed in the input box for this item
length	The maximum input text length for this item
custom	Custom HTML to be displayed in the access point for this item.

Member Function Documentation

getID()

const char * WiFiConnectParam::getID

(

)

Function to get the current id of the item.

Returns

The current id

getValue()

const char * WiFiConnectParam::getValue

(

)

Function to get the current value of the item.

Returns

The current value

getPlaceholder()

const char * WiFiConnectParam::getPlaceholder

(

)

Function to get the current placeholder text of the item.

Returns

The current placeholder text

getValueLength()

int WiFiConnectParam::getValueLength

(

)

Function to get the maximum length allowed for the value of the item.

Returns

The current maximum value length

getCustomHTML()

const char * WiFiConnectParam::getCustomHTML

(

)

Function to get the current custom html markup of the item.

Returns

The current custom html markup

setValue()

void WiFiConnectParam::setValue

(

const char *

newValue

)

Method to change the current value of the item.

Parameters

newValue

The new string value for the item

---

The documentation for this class was generated from the following files:

• src/WiFiConnectParam.h
• src/WiFiConnectParam.cpp