SplashLoginAttemptsApi
SplashLoginAttemptsApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getNetworkSplashLoginAttempts() : object
- Operation getNetworkSplashLoginAttempts
- getNetworkSplashLoginAttemptsAsync() : PromiseInterface
- Operation getNetworkSplashLoginAttemptsAsync
- getNetworkSplashLoginAttemptsAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkSplashLoginAttemptsAsyncWithHttpInfo
- getNetworkSplashLoginAttemptsWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkSplashLoginAttemptsWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getNetworkSplashLoginAttemptsRequest() : Request
- Create request for operation 'getNetworkSplashLoginAttempts'
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ]) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
Return values
mixed —getConfig()
public
getConfig() : Configuration
Return values
Configuration —getNetworkSplashLoginAttempts()
Operation getNetworkSplashLoginAttempts
public
getNetworkSplashLoginAttempts(string $network_id[, int $ssid_number = null ][, string $login_identifier = null ][, int $timespan = null ]) : object
List the splash login attempts for a network
Parameters
- $network_id : string
-
network_id (required)
- $ssid_number : int = null
-
Only return the login attempts for the specified SSID (optional)
- $login_identifier : string = null
-
The username, email, or phone number used during login (optional)
- $timespan : int = null
-
The timespan, in seconds, for the login attempts. The period will be from [timespan] seconds ago until now. The maximum timespan is 3 months (optional)
Tags
Return values
object —getNetworkSplashLoginAttemptsAsync()
Operation getNetworkSplashLoginAttemptsAsync
public
getNetworkSplashLoginAttemptsAsync(string $network_id[, int $ssid_number = null ][, string $login_identifier = null ][, int $timespan = null ]) : PromiseInterface
List the splash login attempts for a network
Parameters
- $network_id : string
-
(required)
- $ssid_number : int = null
-
Only return the login attempts for the specified SSID (optional)
- $login_identifier : string = null
-
The username, email, or phone number used during login (optional)
- $timespan : int = null
-
The timespan, in seconds, for the login attempts. The period will be from [timespan] seconds ago until now. The maximum timespan is 3 months (optional)
Tags
Return values
PromiseInterface —getNetworkSplashLoginAttemptsAsyncWithHttpInfo()
Operation getNetworkSplashLoginAttemptsAsyncWithHttpInfo
public
getNetworkSplashLoginAttemptsAsyncWithHttpInfo(string $network_id[, int $ssid_number = null ][, string $login_identifier = null ][, int $timespan = null ]) : PromiseInterface
List the splash login attempts for a network
Parameters
- $network_id : string
-
(required)
- $ssid_number : int = null
-
Only return the login attempts for the specified SSID (optional)
- $login_identifier : string = null
-
The username, email, or phone number used during login (optional)
- $timespan : int = null
-
The timespan, in seconds, for the login attempts. The period will be from [timespan] seconds ago until now. The maximum timespan is 3 months (optional)
Tags
Return values
PromiseInterface —getNetworkSplashLoginAttemptsWithHttpInfo()
Operation getNetworkSplashLoginAttemptsWithHttpInfo
public
getNetworkSplashLoginAttemptsWithHttpInfo(string $network_id[, int $ssid_number = null ][, string $login_identifier = null ][, int $timespan = null ]) : array<string|int, mixed>
List the splash login attempts for a network
Parameters
- $network_id : string
-
(required)
- $ssid_number : int = null
-
Only return the login attempts for the specified SSID (optional)
- $login_identifier : string = null
-
The username, email, or phone number used during login (optional)
- $timespan : int = null
-
The timespan, in seconds, for the login attempts. The period will be from [timespan] seconds ago until now. The maximum timespan is 3 months (optional)
Tags
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
Return values
array<string|int, mixed> —of http client options
getNetworkSplashLoginAttemptsRequest()
Create request for operation 'getNetworkSplashLoginAttempts'
protected
getNetworkSplashLoginAttemptsRequest(string $network_id[, int $ssid_number = null ][, string $login_identifier = null ][, int $timespan = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $ssid_number : int = null
-
Only return the login attempts for the specified SSID (optional)
- $login_identifier : string = null
-
The username, email, or phone number used during login (optional)
- $timespan : int = null
-
The timespan, in seconds, for the login attempts. The period will be from [timespan] seconds ago until now. The maximum timespan is 3 months (optional)