BUWifiConfig Class Reference

Inherits from BUNetworkConfig : NSObject
Declared in BUNetworkManager.h

Overview

Configuration for performing a Wifi BlinkUp

  ssid

The ssid of the network to connect to

@property (nonatomic, copy, nullable) NSString *ssid

Declared In

BUNetworkManager.h

  password

The password of the network. Be sure to check the useSavedPassword property before choosing this property or the savedPassword. If this property is set, useSavedPassword will be changed to NO

@property (nonatomic, copy, nullable) NSString *password

Declared In

BUNetworkManager.h

  useSavedPassword

If this option is true, a previously stored password will be used If this option is false, the password property will be used Note: setting the password will automatically change this property to NO Note: calling removeConfig with automatically change this property to NO

@property (nonatomic, assign) BOOL useSavedPassword

Discussion

If this option is true, a previously stored password will be used If this option is false, the password property will be used Note: setting the password will automatically change this property to NO Note: calling removeConfig with automatically change this property to NO

Declared In

BUNetworkManager.h

  savedPassword

The password that was saved for the SSID

@property (nonatomic, readonly, nullable) NSString *savedPassword

Declared In

BUNetworkManager.h

– initWithExistingSSID:

Initializes the object with the ssid given. Sets the useSavedPassword property to true by default

- (nonnull instancetype)initWithExistingSSID:(nonnull NSString *)ssid

Parameters

ssid

SSID to use for this configuration

Return Value

BUWifiConfig object with the SSID set

Discussion

Initializes the object with the ssid given. Sets the useSavedPassword property to true by default

Declared In

BUNetworkManager.h

– initWithSSID:password:

Initializes the object with an ssid and password. By default useSavedPassword is false

- (nonnull instancetype)initWithSSID:(nonnull NSString *)ssid password:(nullable NSString *)password

Parameters

ssid

SSID to use for this configuration

password

Password for the SSID

Return Value

BUWifiConfig object with the SSID and Password set

Discussion

Initializes the object with an ssid and password. By default useSavedPassword is false

Declared In

BUNetworkManager.h

– init

Standard init does not preset properties

- (nonnull instancetype)init

Return Value

Create a new object without setting the SSID or Password

Discussion

Standard init does not preset properties

Declared In

BUNetworkManager.h

– saveConfig

Saves the ssid (using the current password property) to storage This should not be called on configurations where useSavedPassword is true as it is already saved

- (void)saveConfig

Discussion

Saves the ssid (using the current password property) to storage This should not be called on configurations where useSavedPassword is true as it is already saved

Declared In

BUNetworkManager.h

– removeConfig

Remove the ssid (and any saved passwords for that ssid) from storage Also sets useSavedPassword to NO

- (void)removeConfig

Discussion

Remove the ssid (and any saved passwords for that ssid) from storage Also sets useSavedPassword to NO

Declared In

BUNetworkManager.h