Documentation

UpdateNetworkWirelessSsidSplashSettings implements ModelInterface, ArrayAccess

UpdateNetworkWirelessSsidSplashSettings Class Doc Comment

Tags
category

Class

author

Swagger Codegen team

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes and Traits

ModelInterface
Interface abstracting model access.
ArrayAccess

Table of Contents

CONTROLLER_DISCONNECTION_BEHAVIOR__DEFAULT  = 'default'
CONTROLLER_DISCONNECTION_BEHAVIOR_OPEN  = 'open'
CONTROLLER_DISCONNECTION_BEHAVIOR_RESTRICTED  = 'restricted'
DISCRIMINATOR  = null
$attributeMap  : array<string|int, string>
Array of attributes where the key is the local name, and the value is the original name
$container  : array<string|int, mixed>
Associative array for storing property values
$getters  : array<string|int, string>
Array of attributes to getter functions (for serialization of requests)
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)
$swaggerFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$swaggerModelName  : string
The original name of the model.
$swaggerTypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
__construct()  : mixed
Constructor
__toString()  : string
Gets the string presentation of the object
attributeMap()  : array<string|int, mixed>
Array of attributes where the key is the local name, and the value is the original name
getAllowSimultaneousLogins()  : bool
Gets allow_simultaneous_logins
getBilling()  : NetworksnetworkIdwirelessssidsnumbersplashsettingsBilling
Gets billing
getBlockAllTrafficBeforeSignOn()  : bool
Gets block_all_traffic_before_sign_on
getControllerDisconnectionBehavior()  : string
Gets controller_disconnection_behavior
getControllerDisconnectionBehaviorAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getGuestSponsorship()  : NetworksnetworkIdwirelessssidsnumbersplashsettingsGuestSponsorship
Gets guest_sponsorship
getModelName()  : string
The original name of the model.
getRedirectUrl()  : string
Gets redirect_url
getSplashImage()  : NetworksnetworkIdwirelessssidsnumbersplashsettingsSplashImage
Gets splash_image
getSplashLogo()  : NetworksnetworkIdwirelessssidsnumbersplashsettingsSplashLogo
Gets splash_logo
getSplashPrepaidFront()  : NetworksnetworkIdwirelessssidsnumbersplashsettingsSplashPrepaidFront
Gets splash_prepaid_front
getSplashTimeout()  : int
Gets splash_timeout
getSplashUrl()  : string
Gets splash_url
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUseRedirectUrl()  : bool
Gets use_redirect_url
getUseSplashUrl()  : bool
Gets use_splash_url
getWelcomeMessage()  : string
Gets welcome_message
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setAllowSimultaneousLogins()  : $this
Sets allow_simultaneous_logins
setBilling()  : $this
Sets billing
setBlockAllTrafficBeforeSignOn()  : $this
Sets block_all_traffic_before_sign_on
setControllerDisconnectionBehavior()  : $this
Sets controller_disconnection_behavior
setGuestSponsorship()  : $this
Sets guest_sponsorship
setRedirectUrl()  : $this
Sets redirect_url
setSplashImage()  : $this
Sets splash_image
setSplashLogo()  : $this
Sets splash_logo
setSplashPrepaidFront()  : $this
Sets splash_prepaid_front
setSplashTimeout()  : $this
Sets splash_timeout
setSplashUrl()  : $this
Sets splash_url
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUseRedirectUrl()  : $this
Sets use_redirect_url
setUseSplashUrl()  : $this
Sets use_splash_url
setWelcomeMessage()  : $this
Sets welcome_message
swaggerFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization
swaggerTypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization
valid()  : bool
Validate all the properties in the model return true if all passed

Constants

Properties

$attributeMap

Array of attributes where the key is the local name, and the value is the original name

protected static array<string|int, string> $attributeMap = ['splash_url' => 'splashUrl', 'use_splash_url' => 'useSplashUrl', 'splash_timeout' => 'splashTimeout', 'redirect_url' => 'redirectUrl', 'use_redirect_url' => 'useRedirectUrl', 'welcome_message' => 'welcomeMessage', 'splash_logo' => 'splashLogo', 'splash_image' => 'splashImage', 'splash_prepaid_front' => 'splashPrepaidFront', 'block_all_traffic_before_sign_on' => 'blockAllTrafficBeforeSignOn', 'controller_disconnection_behavior' => 'controllerDisconnectionBehavior', 'allow_simultaneous_logins' => 'allowSimultaneousLogins', 'guest_sponsorship' => 'guestSponsorship', 'billing' => 'billing']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['splash_url' => 'getSplashUrl', 'use_splash_url' => 'getUseSplashUrl', 'splash_timeout' => 'getSplashTimeout', 'redirect_url' => 'getRedirectUrl', 'use_redirect_url' => 'getUseRedirectUrl', 'welcome_message' => 'getWelcomeMessage', 'splash_logo' => 'getSplashLogo', 'splash_image' => 'getSplashImage', 'splash_prepaid_front' => 'getSplashPrepaidFront', 'block_all_traffic_before_sign_on' => 'getBlockAllTrafficBeforeSignOn', 'controller_disconnection_behavior' => 'getControllerDisconnectionBehavior', 'allow_simultaneous_logins' => 'getAllowSimultaneousLogins', 'guest_sponsorship' => 'getGuestSponsorship', 'billing' => 'getBilling']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['splash_url' => 'setSplashUrl', 'use_splash_url' => 'setUseSplashUrl', 'splash_timeout' => 'setSplashTimeout', 'redirect_url' => 'setRedirectUrl', 'use_redirect_url' => 'setUseRedirectUrl', 'welcome_message' => 'setWelcomeMessage', 'splash_logo' => 'setSplashLogo', 'splash_image' => 'setSplashImage', 'splash_prepaid_front' => 'setSplashPrepaidFront', 'block_all_traffic_before_sign_on' => 'setBlockAllTrafficBeforeSignOn', 'controller_disconnection_behavior' => 'setControllerDisconnectionBehavior', 'allow_simultaneous_logins' => 'setAllowSimultaneousLogins', 'guest_sponsorship' => 'setGuestSponsorship', 'billing' => 'setBilling']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerFormats = ['splash_url' => null, 'use_splash_url' => null, 'splash_timeout' => null, 'redirect_url' => null, 'use_redirect_url' => null, 'welcome_message' => null, 'splash_logo' => null, 'splash_image' => null, 'splash_prepaid_front' => null, 'block_all_traffic_before_sign_on' => null, 'controller_disconnection_behavior' => null, 'allow_simultaneous_logins' => null, 'guest_sponsorship' => null, 'billing' => null]

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['splash_url' => 'string', 'use_splash_url' => 'bool', 'splash_timeout' => 'int', 'redirect_url' => 'string', 'use_redirect_url' => 'bool', 'welcome_message' => 'string', 'splash_logo' => '\Swagger\Client\Model\NetworksnetworkIdwirelessssidsnumbersplashsettingsSplashLogo', 'splash_image' => '\Swagger\Client\Model\NetworksnetworkIdwirelessssidsnumbersplashsettingsSplashImage', 'splash_prepaid_front' => '\Swagger\Client\Model\NetworksnetworkIdwirelessssidsnumbersplashsettingsSplashPrepaidFront', 'block_all_traffic_before_sign_on' => 'bool', 'controller_disconnection_behavior' => 'string', 'allow_simultaneous_logins' => 'bool', 'guest_sponsorship' => '\Swagger\Client\Model\NetworksnetworkIdwirelessssidsnumbersplashsettingsGuestSponsorship', 'billing' => '\Swagger\Client\Model\NetworksnetworkIdwirelessssidsnumbersplashsettingsBilling']

Methods

__construct()

Constructor

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

Associated array of property values initializing the model

Return values
mixed —

attributeMap()

Array of attributes where the key is the local name, and the value is the original name

public static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getControllerDisconnectionBehaviorAllowableValues()

Gets allowable values of the enum

public getControllerDisconnectionBehaviorAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

listInvalidProperties()

Show all the invalid properties with reasons.

public listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —

invalid properties with reasons

offsetSet()

Sets value based on offset.

public offsetSet(int $offset, mixed $value) : void
Parameters
$offset : int

Offset

$value : mixed

Value to be set

Return values
void —

setAllowSimultaneousLogins()

Sets allow_simultaneous_logins

public setAllowSimultaneousLogins(bool $allow_simultaneous_logins) : $this
Parameters
$allow_simultaneous_logins : bool

Whether or not to allow simultaneous logins from different devices.

Return values
$this —

setBlockAllTrafficBeforeSignOn()

Sets block_all_traffic_before_sign_on

public setBlockAllTrafficBeforeSignOn(bool $block_all_traffic_before_sign_on) : $this
Parameters
$block_all_traffic_before_sign_on : bool

How restricted allowing traffic should be. If true, all traffic types are blocked until the splash page is acknowledged. If false, all non-HTTP traffic is allowed before the splash page is acknowledged.

Return values
$this —

setControllerDisconnectionBehavior()

Sets controller_disconnection_behavior

public setControllerDisconnectionBehavior(string $controller_disconnection_behavior) : $this
Parameters
$controller_disconnection_behavior : string

How login attempts should be handled when the controller is unreachable. Can be either 'open', 'restricted', or 'default'.

Return values
$this —

setRedirectUrl()

Sets redirect_url

public setRedirectUrl(string $redirect_url) : $this
Parameters
$redirect_url : string

The custom redirect URL where the users will go after the splash page.

Return values
$this —

setSplashTimeout()

Sets splash_timeout

public setSplashTimeout(int $splash_timeout) : $this
Parameters
$splash_timeout : int

Splash timeout in minutes. This will determine how often users will see the splash page.

Return values
$this —

setSplashUrl()

Sets splash_url

public setSplashUrl(string $splash_url) : $this
Parameters
$splash_url : string

[optional] The custom splash URL of the click-through splash page. Note that the URL can be configured without necessarily being used. In order to enable the custom URL, see 'useSplashUrl'

Return values
$this —

setters()

Array of attributes to setter functions (for deserialization of responses)

public static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

setUseRedirectUrl()

Sets use_redirect_url

public setUseRedirectUrl(bool $use_redirect_url) : $this
Parameters
$use_redirect_url : bool

The Boolean indicating whether the the user will be redirected to the custom redirect URL after the splash page. A custom redirect URL must be set if this is true.

Return values
$this —

setUseSplashUrl()

Sets use_splash_url

public setUseSplashUrl(bool $use_splash_url) : $this
Parameters
$use_splash_url : bool

[optional] Boolean indicating whether the users will be redirected to the custom splash url. A custom splash URL must be set if this is true. Note that depending on your SSID's access control settings, it may not be possible to use the custom splash URL.

Return values
$this —

setWelcomeMessage()

Sets welcome_message

public setWelcomeMessage(string $welcome_message) : $this
Parameters
$welcome_message : string

The welcome message for the users on the splash page.

Return values
$this —

swaggerFormats()

Array of property to format mappings. Used for (de)serialization

public static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —

swaggerTypes()

Array of property to type mappings. Used for (de)serialization

public static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Search results