Documentation

SplashApi

SplashApi Class Doc Comment

Tags
category

Class

author

Swagger Codegen team

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

Table of Contents

$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
__construct()  : mixed
getConfig()  : Configuration
getNetworkWirelessSsidSplashSettings()  : object
Operation getNetworkWirelessSsidSplashSettings
getNetworkWirelessSsidSplashSettingsAsync()  : PromiseInterface
Operation getNetworkWirelessSsidSplashSettingsAsync
getNetworkWirelessSsidSplashSettingsAsyncWithHttpInfo()  : PromiseInterface
Operation getNetworkWirelessSsidSplashSettingsAsyncWithHttpInfo
getNetworkWirelessSsidSplashSettingsWithHttpInfo()  : array<string|int, mixed>
Operation getNetworkWirelessSsidSplashSettingsWithHttpInfo
updateNetworkWirelessSsidSplashSettings()  : object
Operation updateNetworkWirelessSsidSplashSettings
updateNetworkWirelessSsidSplashSettingsAsync()  : PromiseInterface
Operation updateNetworkWirelessSsidSplashSettingsAsync
updateNetworkWirelessSsidSplashSettingsAsyncWithHttpInfo()  : PromiseInterface
Operation updateNetworkWirelessSsidSplashSettingsAsyncWithHttpInfo
updateNetworkWirelessSsidSplashSettingsWithHttpInfo()  : array<string|int, mixed>
Operation updateNetworkWirelessSsidSplashSettingsWithHttpInfo
createHttpClientOption()  : array<string|int, mixed>
Create http client option
getNetworkWirelessSsidSplashSettingsRequest()  : Request
Create request for operation 'getNetworkWirelessSsidSplashSettings'
updateNetworkWirelessSsidSplashSettingsRequest()  : Request
Create request for operation 'updateNetworkWirelessSsidSplashSettings'

Properties

Methods

getNetworkWirelessSsidSplashSettings()

Operation getNetworkWirelessSsidSplashSettings

public getNetworkWirelessSsidSplashSettings(string $network_id, string $number) : object

Display the splash page settings for the given SSID

Parameters
$network_id : string

network_id (required)

$number : string

number (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object

getNetworkWirelessSsidSplashSettingsAsync()

Operation getNetworkWirelessSsidSplashSettingsAsync

public getNetworkWirelessSsidSplashSettingsAsync(string $network_id, string $number) : PromiseInterface

Display the splash page settings for the given SSID

Parameters
$network_id : string

(required)

$number : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getNetworkWirelessSsidSplashSettingsAsyncWithHttpInfo()

Operation getNetworkWirelessSsidSplashSettingsAsyncWithHttpInfo

public getNetworkWirelessSsidSplashSettingsAsyncWithHttpInfo(string $network_id, string $number) : PromiseInterface

Display the splash page settings for the given SSID

Parameters
$network_id : string

(required)

$number : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getNetworkWirelessSsidSplashSettingsWithHttpInfo()

Operation getNetworkWirelessSsidSplashSettingsWithHttpInfo

public getNetworkWirelessSsidSplashSettingsWithHttpInfo(string $network_id, string $number) : array<string|int, mixed>

Display the splash page settings for the given SSID

Parameters
$network_id : string

(required)

$number : string

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of object, HTTP status code, HTTP response headers (array of strings)

updateNetworkWirelessSsidSplashSettings()

Operation updateNetworkWirelessSsidSplashSettings

public updateNetworkWirelessSsidSplashSettings(string $network_id, string $number[, UpdateNetworkWirelessSsidSplashSettings $update_network_wireless_ssid_splash_settings = null ]) : object

Modify the splash page settings for the given SSID

Parameters
$network_id : string

network_id (required)

$number : string

number (required)

$update_network_wireless_ssid_splash_settings : UpdateNetworkWirelessSsidSplashSettings = null

update_network_wireless_ssid_splash_settings (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object

updateNetworkWirelessSsidSplashSettingsAsync()

Operation updateNetworkWirelessSsidSplashSettingsAsync

public updateNetworkWirelessSsidSplashSettingsAsync(string $network_id, string $number[, UpdateNetworkWirelessSsidSplashSettings $update_network_wireless_ssid_splash_settings = null ]) : PromiseInterface

Modify the splash page settings for the given SSID

Parameters
$network_id : string

(required)

$number : string

(required)

$update_network_wireless_ssid_splash_settings : UpdateNetworkWirelessSsidSplashSettings = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateNetworkWirelessSsidSplashSettingsAsyncWithHttpInfo()

Operation updateNetworkWirelessSsidSplashSettingsAsyncWithHttpInfo

public updateNetworkWirelessSsidSplashSettingsAsyncWithHttpInfo(string $network_id, string $number[, UpdateNetworkWirelessSsidSplashSettings $update_network_wireless_ssid_splash_settings = null ]) : PromiseInterface

Modify the splash page settings for the given SSID

Parameters
$network_id : string

(required)

$number : string

(required)

$update_network_wireless_ssid_splash_settings : UpdateNetworkWirelessSsidSplashSettings = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateNetworkWirelessSsidSplashSettingsWithHttpInfo()

Operation updateNetworkWirelessSsidSplashSettingsWithHttpInfo

public updateNetworkWirelessSsidSplashSettingsWithHttpInfo(string $network_id, string $number[, UpdateNetworkWirelessSsidSplashSettings $update_network_wireless_ssid_splash_settings = null ]) : array<string|int, mixed>

Modify the splash page settings for the given SSID

Parameters
$network_id : string

(required)

$number : string

(required)

$update_network_wireless_ssid_splash_settings : UpdateNetworkWirelessSsidSplashSettings = null

(optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of object, HTTP status code, HTTP response headers (array of strings)

createHttpClientOption()

Create http client option

protected createHttpClientOption() : array<string|int, mixed>
Tags
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed>

of http client options

getNetworkWirelessSsidSplashSettingsRequest()

Create request for operation 'getNetworkWirelessSsidSplashSettings'

protected getNetworkWirelessSsidSplashSettingsRequest(string $network_id, string $number) : Request
Parameters
$network_id : string

(required)

$number : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request

updateNetworkWirelessSsidSplashSettingsRequest()

Create request for operation 'updateNetworkWirelessSsidSplashSettings'

protected updateNetworkWirelessSsidSplashSettingsRequest(string $network_id, string $number[, UpdateNetworkWirelessSsidSplashSettings $update_network_wireless_ssid_splash_settings = null ]) : Request
Parameters
$network_id : string

(required)

$number : string

(required)

$update_network_wireless_ssid_splash_settings : UpdateNetworkWirelessSsidSplashSettings = null

(optional)

Tags
throws
InvalidArgumentException
Return values
Request

Search results