Supla\ApiClient\UserIconsApi

All URIs are relative to https://YOUR_SUPLA_SERVER/api/v3.

Method	HTTP request	Description
createUserIcon()	POST /user-icons	Create a new User Icon
createUserIconBase64()	POST /user-icons.base64	Create a new User Icon sent in Base64 format.
deleteUserIcon()	DELETE /user-icons/{id}	Delete the User Icon
getUserIcon()	GET /user-icons/{id}	Get User Icon
getUserIconImage()	GET /user-icons/{id}/{imageIndex}	Get User Icon image at specified index
getUserIcons()	GET /user-icons	List User Icons

`createUserIcon()`

createUserIcon($function, $sourceIcon, $image1, $image2, $image3, $image4, $imageDark1, $imageDark2, $imageDark3, $imageDark4): \Supla\ApiClient\Model\UserIcon

Create a new User Icon

Example

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


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

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


$apiInstance = new Supla\ApiClient\Api\UserIconsApi(
    // 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 = 'function_example'; // string
$sourceIcon = 56; // int | ID of an existing user icon to replace with these new files. Optional.
$image1 = "/path/to/file.txt"; // \SplFileObject
$image2 = "/path/to/file.txt"; // \SplFileObject
$image3 = "/path/to/file.txt"; // \SplFileObject
$image4 = "/path/to/file.txt"; // \SplFileObject
$imageDark1 = "/path/to/file.txt"; // \SplFileObject
$imageDark2 = "/path/to/file.txt"; // \SplFileObject
$imageDark3 = "/path/to/file.txt"; // \SplFileObject
$imageDark4 = "/path/to/file.txt"; // \SplFileObject

try {
    $result = $apiInstance->createUserIcon($function, $sourceIcon, $image1, $image2, $image3, $image4, $imageDark1, $imageDark2, $imageDark3, $imageDark4);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserIconsApi->createUserIcon: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
function	string		[optional]
sourceIcon	int	ID of an existing user icon to replace with these new files. Optional.	[optional]
image1	\SplFileObject\SplFileObject		[optional]
image2	\SplFileObject\SplFileObject		[optional]
image3	\SplFileObject\SplFileObject		[optional]
image4	\SplFileObject\SplFileObject		[optional]
imageDark1	\SplFileObject\SplFileObject		[optional]
imageDark2	\SplFileObject\SplFileObject		[optional]
imageDark3	\SplFileObject\SplFileObject		[optional]
imageDark4	\SplFileObject\SplFileObject		[optional]

Return type

\Supla\ApiClient\Model\UserIcon

Authorization

BearerAuth, OAuth2

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

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

`createUserIconBase64()`

createUserIconBase64($inlineObject14): \Supla\ApiClient\Model\UserIcon

Create a new User Icon sent in Base64 format.

Example

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


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

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


$apiInstance = new Supla\ApiClient\Api\UserIconsApi(
    // 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
);
$inlineObject14 = new \Supla\ApiClient\Model\InlineObject14(); // \Supla\ApiClient\Model\InlineObject14

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

Parameters

Name	Type	Description	Notes
inlineObject14	\Supla\ApiClient\Model\InlineObject14

Return type

\Supla\ApiClient\Model\UserIcon

Authorization

BearerAuth, OAuth2

HTTP request headers

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

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

`deleteUserIcon()`

deleteUserIcon($id)

Delete the User Icon

Example

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


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

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


$apiInstance = new Supla\ApiClient\Api\UserIconsApi(
    // 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->deleteUserIcon($id);
} catch (Exception $e) {
    echo 'Exception when calling UserIconsApi->deleteUserIcon: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	ID

Return type

void (empty response body)

Authorization

BearerAuth, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`getUserIcon()`

getUserIcon($id, $include): \Supla\ApiClient\Model\UserIcon

Get User Icon

Example

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


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

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


$apiInstance = new Supla\ApiClient\Api\UserIconsApi(
    // 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
$include = array('include_example'); // string[] | List of extra fields to include in the response.

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

Parameters

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

Return type

\Supla\ApiClient\Model\UserIcon

Authorization

BearerAuth, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getUserIconImage()`

getUserIconImage($id, $imageIndex, $dark): \SplFileObject

Get User Icon image at specified index

Example

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


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

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


$apiInstance = new Supla\ApiClient\Api\UserIconsApi(
    // 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
$imageIndex = 56; // int
$dark = True; // bool

try {
    $result = $apiInstance->getUserIconImage($id, $imageIndex, $dark);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserIconsApi->getUserIconImage: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
id	int
imageIndex	int
dark	bool	[optional]

Return type

\SplFileObject

Authorization

BearerAuth, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: image/_*

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

`getUserIcons()`

getUserIcons($function, $ids, $include): \Supla\ApiClient\Model\UserIcon[]

List User Icons

Example

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


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

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


$apiInstance = new Supla\ApiClient\Api\UserIconsApi(
    // 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[]
$ids = array(56); // int[]
$include = array('include_example'); // string[] | List of extra fields to include in the response.

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

Parameters

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

Return type

\Supla\ApiClient\Model\UserIcon[]

Authorization

BearerAuth, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

Files

UserIconsApi.md

Latest commit

History

UserIconsApi.md

File metadata and controls

Supla\ApiClient\UserIconsApi

createUserIcon()

Example

Parameters

Return type

Authorization

HTTP request headers

createUserIconBase64()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteUserIcon()

Example

Parameters

Return type

Authorization

HTTP request headers

getUserIcon()

Example

Parameters

Return type

Authorization

HTTP request headers

getUserIconImage()

Example

Parameters

Return type

Authorization

HTTP request headers

getUserIcons()

Example

Parameters

Return type

Authorization

HTTP request headers

`createUserIcon()`

`createUserIconBase64()`

`deleteUserIcon()`

`getUserIcon()`

`getUserIconImage()`

`getUserIcons()`