Supla\ApiClient\ChannelGroupsApi

All URIs are relative to https://YOUR_SUPLA_SERVER/api/v3, except if the operation defines another base path.

Method	HTTP request	Description
createChannelGroup()	POST /channel-groups	Create a new channel group
deleteChannelGroup()	DELETE /channel-groups/{id}	Delete the channel group
executeActionOnChannelGroup()	PATCH /channel-groups/{id}
getChannelGroup()	GET /channel-groups/{id}	Get Channel Group
getChannelGroupDirectLinks()	GET /channel-groups/{channelGroup}/direct-links	Get channel group direct links
getChannelGroupScenes()	GET /channel-groups/{channelGroup}/scenes	Get channel group scenes
getChannelGroups()	GET /channel-groups	Get Channel Groups
updateChannelGroup()	PUT /channel-groups/{id}	Update the channel group

`createChannelGroup()`

createChannelGroup($createChannelGroupRequest): \Supla\ApiClient\Model\ChannelGroup

Create a new channel group

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Supla\ApiClient\Api\ChannelGroupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$createChannelGroupRequest = new \Supla\ApiClient\Model\CreateChannelGroupRequest(); // \Supla\ApiClient\Model\CreateChannelGroupRequest

try {
    $result = $apiInstance->createChannelGroup($createChannelGroupRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChannelGroupsApi->createChannelGroup: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
createChannelGroupRequest	\Supla\ApiClient\Model\CreateChannelGroupRequest

Return type

\Supla\ApiClient\Model\ChannelGroup

Authorization

OAuth2, BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteChannelGroup()`

deleteChannelGroup($id)

Delete the channel group

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Supla\ApiClient\Api\ChannelGroupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | ID

try {
    $apiInstance->deleteChannelGroup($id);
} catch (Exception $e) {
    echo 'Exception when calling ChannelGroupsApi->deleteChannelGroup: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	ID

Return type

void (empty response body)

Authorization

OAuth2, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`executeActionOnChannelGroup()`

executeActionOnChannelGroup($id, $executeActionOnChannelGroupRequest)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Supla\ApiClient\Api\ChannelGroupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | ID
$executeActionOnChannelGroupRequest = new \Supla\ApiClient\Model\ExecuteActionOnChannelGroupRequest(); // \Supla\ApiClient\Model\ExecuteActionOnChannelGroupRequest

try {
    $apiInstance->executeActionOnChannelGroup($id, $executeActionOnChannelGroupRequest);
} catch (Exception $e) {
    echo 'Exception when calling ChannelGroupsApi->executeActionOnChannelGroup: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	ID
executeActionOnChannelGroupRequest	\Supla\ApiClient\Model\ExecuteActionOnChannelGroupRequest

Return type

void (empty response body)

Authorization

OAuth2, BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getChannelGroup()`

getChannelGroup($id, $include): \Supla\ApiClient\Model\ChannelGroup

Get Channel Group

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Supla\ApiClient\Api\ChannelGroupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | ID
$include = array('include_example'); // string[] | List of extra fields to include in the response.

try {
    $result = $apiInstance->getChannelGroup($id, $include);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChannelGroupsApi->getChannelGroup: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	ID
include	string[]	List of extra fields to include in the response.	[optional]

Return type

\Supla\ApiClient\Model\ChannelGroup

Authorization

OAuth2, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getChannelGroupDirectLinks()`

getChannelGroupDirectLinks($channelGroup, $include): \Supla\ApiClient\Model\DirectLink[]

Get channel group direct links

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Supla\ApiClient\Api\ChannelGroupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$channelGroup = 56; // int | ID
$include = array('include_example'); // string[] | List of extra fields to include in the response.

try {
    $result = $apiInstance->getChannelGroupDirectLinks($channelGroup, $include);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChannelGroupsApi->getChannelGroupDirectLinks: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
channelGroup	int	ID
include	string[]	List of extra fields to include in the response.	[optional]

Return type

\Supla\ApiClient\Model\DirectLink[]

Authorization

OAuth2, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getChannelGroupScenes()`

getChannelGroupScenes($channelGroup, $include): \Supla\ApiClient\Model\Scene[]

Get channel group scenes

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Supla\ApiClient\Api\ChannelGroupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$channelGroup = 56; // int | ID
$include = array('include_example'); // string[] | List of extra fields to include in the response.

try {
    $result = $apiInstance->getChannelGroupScenes($channelGroup, $include);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChannelGroupsApi->getChannelGroupScenes: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
channelGroup	int	ID
include	string[]	List of extra fields to include in the response.	[optional]

Return type

\Supla\ApiClient\Model\Scene[]

Authorization

OAuth2, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getChannelGroups()`

getChannelGroups($function, $include): \Supla\ApiClient\Model\ChannelGroup[]

Get Channel Groups

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Supla\ApiClient\Api\ChannelGroupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$function = array('function_example'); // string[]
$include = array('include_example'); // string[] | List of extra fields to include in the response.

try {
    $result = $apiInstance->getChannelGroups($function, $include);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChannelGroupsApi->getChannelGroups: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
function	string[]		[optional]
include	string[]	List of extra fields to include in the response.	[optional]

Return type

\Supla\ApiClient\Model\ChannelGroup[]

Authorization

OAuth2, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateChannelGroup()`

updateChannelGroup($id, $createChannelGroupRequest): \Supla\ApiClient\Model\ChannelGroup

Update the channel group

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Supla\ApiClient\Api\ChannelGroupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | ID
$createChannelGroupRequest = new \Supla\ApiClient\Model\CreateChannelGroupRequest(); // \Supla\ApiClient\Model\CreateChannelGroupRequest

try {
    $result = $apiInstance->updateChannelGroup($id, $createChannelGroupRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChannelGroupsApi->updateChannelGroup: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	ID
createChannelGroupRequest	\Supla\ApiClient\Model\CreateChannelGroupRequest

Return type

\Supla\ApiClient\Model\ChannelGroup

Authorization

OAuth2, BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

ChannelGroupsApi.md

Latest commit

History

ChannelGroupsApi.md

File metadata and controls

Supla\ApiClient\ChannelGroupsApi

createChannelGroup()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteChannelGroup()

Example

Parameters

Return type

Authorization

HTTP request headers

executeActionOnChannelGroup()

Example

Parameters

Return type

Authorization

HTTP request headers

getChannelGroup()

Example

Parameters

Return type

Authorization

HTTP request headers

getChannelGroupDirectLinks()

Example

Parameters

Return type

Authorization

HTTP request headers

getChannelGroupScenes()

Example

Parameters

Return type

Authorization

HTTP request headers

getChannelGroups()

Example

Parameters

Return type

Authorization

HTTP request headers

updateChannelGroup()

Example

Parameters

Return type

Authorization

HTTP request headers

`createChannelGroup()`

`deleteChannelGroup()`

`executeActionOnChannelGroup()`

`getChannelGroup()`

`getChannelGroupDirectLinks()`

`getChannelGroupScenes()`

`getChannelGroups()`

`updateChannelGroup()`