ConnectivityEventsApi
ConnectivityEventsApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getNetworkWirelessClientConnectivityEvents() : object
- Operation getNetworkWirelessClientConnectivityEvents
- getNetworkWirelessClientConnectivityEventsAsync() : PromiseInterface
- Operation getNetworkWirelessClientConnectivityEventsAsync
- getNetworkWirelessClientConnectivityEventsAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkWirelessClientConnectivityEventsAsyncWithHttpInfo
- getNetworkWirelessClientConnectivityEventsWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkWirelessClientConnectivityEventsWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getNetworkWirelessClientConnectivityEventsRequest() : Request
- Create request for operation 'getNetworkWirelessClientConnectivityEvents'
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 —getNetworkWirelessClientConnectivityEvents()
Operation getNetworkWirelessClientConnectivityEvents
public
getNetworkWirelessClientConnectivityEvents(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, array<string|int, string> $types = null ][, array<string|int, string> $included_severities = null ][, string $band = null ][, int $ssid_number = null ][, string $device_serial = null ]) : object
List the wireless connectivity events for a client within a network in the timespan.
Parameters
- $network_id : string
-
network_id (required)
- $client_id : string
-
client_id (required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. (optional)
- $types : array<string|int, string> = null
-
A list of event types to include. If not specified, events of all types will be returned. Valid types are 'assoc', 'disassoc', 'auth', 'deauth', 'dns', 'dhcp', 'roam', 'connection' and/or 'sticky'. (optional)
- $included_severities : array<string|int, string> = null
-
A list of severities to include. If not specified, events of all severities will be returned. Valid severities are 'good', 'info', 'warn' and/or 'bad'. (optional)
- $band : string = null
-
Filter results by band (either '2.4' or '5'). (optional)
- $ssid_number : int = null
-
An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
- $device_serial : string = null
-
Filter results by an AP's serial number. (optional)
Tags
Return values
object —getNetworkWirelessClientConnectivityEventsAsync()
Operation getNetworkWirelessClientConnectivityEventsAsync
public
getNetworkWirelessClientConnectivityEventsAsync(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, array<string|int, string> $types = null ][, array<string|int, string> $included_severities = null ][, string $band = null ][, int $ssid_number = null ][, string $device_serial = null ]) : PromiseInterface
List the wireless connectivity events for a client within a network in the timespan.
Parameters
- $network_id : string
-
(required)
- $client_id : string
-
(required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. (optional)
- $types : array<string|int, string> = null
-
A list of event types to include. If not specified, events of all types will be returned. Valid types are 'assoc', 'disassoc', 'auth', 'deauth', 'dns', 'dhcp', 'roam', 'connection' and/or 'sticky'. (optional)
- $included_severities : array<string|int, string> = null
-
A list of severities to include. If not specified, events of all severities will be returned. Valid severities are 'good', 'info', 'warn' and/or 'bad'. (optional)
- $band : string = null
-
Filter results by band (either '2.4' or '5'). (optional)
- $ssid_number : int = null
-
An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
- $device_serial : string = null
-
Filter results by an AP's serial number. (optional)
Tags
Return values
PromiseInterface —getNetworkWirelessClientConnectivityEventsAsyncWithHttpInfo()
Operation getNetworkWirelessClientConnectivityEventsAsyncWithHttpInfo
public
getNetworkWirelessClientConnectivityEventsAsyncWithHttpInfo(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, array<string|int, string> $types = null ][, array<string|int, string> $included_severities = null ][, string $band = null ][, int $ssid_number = null ][, string $device_serial = null ]) : PromiseInterface
List the wireless connectivity events for a client within a network in the timespan.
Parameters
- $network_id : string
-
(required)
- $client_id : string
-
(required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. (optional)
- $types : array<string|int, string> = null
-
A list of event types to include. If not specified, events of all types will be returned. Valid types are 'assoc', 'disassoc', 'auth', 'deauth', 'dns', 'dhcp', 'roam', 'connection' and/or 'sticky'. (optional)
- $included_severities : array<string|int, string> = null
-
A list of severities to include. If not specified, events of all severities will be returned. Valid severities are 'good', 'info', 'warn' and/or 'bad'. (optional)
- $band : string = null
-
Filter results by band (either '2.4' or '5'). (optional)
- $ssid_number : int = null
-
An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
- $device_serial : string = null
-
Filter results by an AP's serial number. (optional)
Tags
Return values
PromiseInterface —getNetworkWirelessClientConnectivityEventsWithHttpInfo()
Operation getNetworkWirelessClientConnectivityEventsWithHttpInfo
public
getNetworkWirelessClientConnectivityEventsWithHttpInfo(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, array<string|int, string> $types = null ][, array<string|int, string> $included_severities = null ][, string $band = null ][, int $ssid_number = null ][, string $device_serial = null ]) : array<string|int, mixed>
List the wireless connectivity events for a client within a network in the timespan.
Parameters
- $network_id : string
-
(required)
- $client_id : string
-
(required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. (optional)
- $types : array<string|int, string> = null
-
A list of event types to include. If not specified, events of all types will be returned. Valid types are 'assoc', 'disassoc', 'auth', 'deauth', 'dns', 'dhcp', 'roam', 'connection' and/or 'sticky'. (optional)
- $included_severities : array<string|int, string> = null
-
A list of severities to include. If not specified, events of all severities will be returned. Valid severities are 'good', 'info', 'warn' and/or 'bad'. (optional)
- $band : string = null
-
Filter results by band (either '2.4' or '5'). (optional)
- $ssid_number : int = null
-
An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
- $device_serial : string = null
-
Filter results by an AP's serial number. (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
getNetworkWirelessClientConnectivityEventsRequest()
Create request for operation 'getNetworkWirelessClientConnectivityEvents'
protected
getNetworkWirelessClientConnectivityEventsRequest(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, array<string|int, string> $types = null ][, array<string|int, string> $included_severities = null ][, string $band = null ][, int $ssid_number = null ][, string $device_serial = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $client_id : string
-
(required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. (optional)
- $types : array<string|int, string> = null
-
A list of event types to include. If not specified, events of all types will be returned. Valid types are 'assoc', 'disassoc', 'auth', 'deauth', 'dns', 'dhcp', 'roam', 'connection' and/or 'sticky'. (optional)
- $included_severities : array<string|int, string> = null
-
A list of severities to include. If not specified, events of all severities will be returned. Valid severities are 'good', 'info', 'warn' and/or 'bad'. (optional)
- $band : string = null
-
Filter results by band (either '2.4' or '5'). (optional)
- $ssid_number : int = null
-
An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
- $device_serial : string = null
-
Filter results by an AP's serial number. (optional)