IProfile

​

Interface IProfile

interface IProfile

Extends com.amazon.apmf.IStandard Represents a Wi-Fi profile to connect.

​

Methods

​

setSsid()

void setSsid(string ssid)

Set Service Set Identifier (SSID) of this Profile. A valid SSID is 0-32 octets with UTF-8 encoding.

​

Parameters

ssid

string — Required SSID of this Profile.

---

​

getSsid()

string? getSsid()

Get Service Set Identifier (SSID) of this Profile.

​

Returns

string? The return value is optional and might be absent. SSID on success.

---

​

setPassphrase()

void setPassphrase(string passphrase)

Set the passphrase for WPA-PSK, WPA2-PSK, and WPA3-SAE. A valid passphrase for WPA-PSK and WPA2-PSK is 8-63 octets with ASCII encoding or 64 octets with HEX characters.

​

Parameters

passphrase

string — Required passphrase of this Profile.

---

​

getPassphrase()

string? getPassphrase()

Get the Passphrase of this Profile.

​

Returns

string? The return value is optional and might be absent. PSK on success.

---

​

setWepKeys()

void setWepKeys(u8 wepKeyIndex, string[] wepKeys)

Set the Wired Equivalent Privacy (WEP) keys and WEP key index. up to 4 keys can be set and each key should have 5 or 13 octets with ASCII encoding or 10 or 26 HEX characters.

​

Parameters

wepKeyIndex

u8 — Required WEP key index to transmit data.

wepKeys

string[] — Required WEP keys of this Profile.

---

​

getWepKeys()

void getWepKeys(out u8* wepKeyIndex, out string[]* wepKeys)

Get the Wired Equivalent Privacy (WEP) keys and WEP key index.

​

Parameters

wepKeyIndex (out)

u8* — Required WEP key index to transmit data.

wepKeys (out)

string[]* — Required WEP keys of this Profile.

---

​

setAuthMode()

void setAuthMode(AuthMode* authMode)

Set the AuthMode of this Profile.

​

Parameters

authMode

AuthMode* — Required AuthMode.

---

​

getAuthMode()

AuthMode getAuthMode()

Get the AuthMode of this Profile.

​

Returns

AuthMode AuthMode.

---

​

setHiddenSsid()

void setHiddenSsid(bool hidden)

Enable or disable hidden SSID.

​

Parameters

hidden

bool — Required enable or disable hidden SSID.

---

​

isHiddenSsid()

bool isHiddenSsid()

Get hidden SSID.

​

Returns

bool true if the SSID is hidden.

---

​

setConfigStatus()

void setConfigStatus(ConfigStatus* configStatus)

Set ConfigStatus of this Profile.

​

Parameters

configStatus

ConfigStatus* — Required ConfigStatus.

---

​

getConfigStatus()

ConfigStatus getConfigStatus()

Get ConfigStatus of this Profile.

​

Returns

ConfigStatus ConfigStatus.

---

​

setTethered()

void setTethered(bool tethered)

enable or disable tethered mode.

​

Parameters

tethered

bool — Required enable or disable tethered mode.

---

​

isTethered()

bool isTethered()

Get tethered mode of this Profile.

​

Returns

bool true if this Profile is tethered.

---

​

setIpConfig()

void setIpConfig(com.amazon.kepler.net.common.IIpConfiguration? ipConfiguration)

Set IIpConfiguration of this Profile.

​

Parameters

ipConfiguration

com.amazon.kepler.net.common.IIpConfiguration? — Optional IIpConfiguration.

---

​

getIpConfig()

com.amazon.kepler.net.common.IIpConfiguration? getIpConfig()

Get IIpConfiguration of this Profile.

​

Returns

com.amazon.kepler.net.common.IIpConfiguration? The return value is optional and might be absent. IIpConfiguration.

---

​

setPriority()

void setPriority(u8 priority)

Set the priority of this Profile among other Profile.

​

Parameters

priority

u8 — Required priority.

---

​

getPriority()

u8 getPriority()

Get the priority of this Profile.

​

Returns

u8 priority.

---