SseControllerApi
in package
SseControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['streamEvents' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- setHostIndex() : void
- Set the host index
- streamEvents() : array<string|int, string>
- Operation streamEvents
- streamEventsAsync() : PromiseInterface
- Operation streamEventsAsync
- streamEventsAsyncWithHttpInfo() : PromiseInterface
- Operation streamEventsAsyncWithHttpInfo
- streamEventsRequest() : Request
- Create request for operation 'streamEvents'
- streamEventsWithHttpInfo() : array<string|int, mixed>
- Operation streamEventsWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['streamEvents' => ['application/json']]
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
$hostIndex
protected
int
$hostIndex
Host index
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
- $hostIndex : int
-
(Optional) host index to select the list of hosts if defined in the OpenAPI spec
Return values
mixed —getConfig()
public
getConfig() : Configuration
Return values
Configuration —getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
setHostIndex()
Set the host index
public
setHostIndex(int $hostIndex) : void
Parameters
- $hostIndex : int
-
Host index (required)
Return values
void —streamEvents()
Operation streamEvents
public
streamEvents(string $x_api_key[, string $contentType = self::contentTypes['streamEvents'][0] ]) : array<string|int, string>
Parameters
- $x_api_key : string
-
x_api_key (required)
- $contentType : string = self::contentTypes['streamEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['streamEvents'] to see the possible values for this operation
Tags
Return values
array<string|int, string> —streamEventsAsync()
Operation streamEventsAsync
public
streamEventsAsync(string $x_api_key[, string $contentType = self::contentTypes['streamEvents'][0] ]) : PromiseInterface
Parameters
- $x_api_key : string
-
(required)
- $contentType : string = self::contentTypes['streamEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['streamEvents'] to see the possible values for this operation
Tags
Return values
PromiseInterface —streamEventsAsyncWithHttpInfo()
Operation streamEventsAsyncWithHttpInfo
public
streamEventsAsyncWithHttpInfo(string $x_api_key[, string $contentType = self::contentTypes['streamEvents'][0] ]) : PromiseInterface
Parameters
- $x_api_key : string
-
(required)
- $contentType : string = self::contentTypes['streamEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['streamEvents'] to see the possible values for this operation
Tags
Return values
PromiseInterface —streamEventsRequest()
Create request for operation 'streamEvents'
public
streamEventsRequest(string $x_api_key[, string $contentType = self::contentTypes['streamEvents'][0] ]) : Request
Parameters
- $x_api_key : string
-
(required)
- $contentType : string = self::contentTypes['streamEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['streamEvents'] to see the possible values for this operation
Tags
Return values
Request —streamEventsWithHttpInfo()
Operation streamEventsWithHttpInfo
public
streamEventsWithHttpInfo(string $x_api_key[, string $contentType = self::contentTypes['streamEvents'][0] ]) : array<string|int, mixed>
Parameters
- $x_api_key : string
-
(required)
- $contentType : string = self::contentTypes['streamEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['streamEvents'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of string[], 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