Alfaview\RoomServiceApi

All URIs are relative to https://localhost

Method	HTTP request	Description
availableTypes	POST /availableTypes	lists all possible room types and calculates their current availability by evaluating quota consumption
callList	POST /list	list all rooms which are accessible by the current user
create	POST /create	creates or replaces all values
createJoinLink	POST /createJoinLink	creates a link to launch the client
destroy	POST /destroy	deletes room and kicks all users
permissions	POST /permissions	Deprecated: use 'Permissions' call in the roomStateService
sort	POST /sort	changes the sorting of rooms
status	POST /status	Deprecated: use 'Status' call in the roomStateService
update	POST /update	adds or overwrites all values

availableTypes

\Alfaview\Model\RoomServiceAvailableTypesReply availableTypes($body)

lists all possible room types and calculates their current availability by evaluating quota consumption

Example

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

$apiInstance = new Alfaview\Api\RoomServiceApi(
    // 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()
);
$body = new \Alfaview\Model\RoomServiceAvailableTypesRequest(); // \Alfaview\Model\RoomServiceAvailableTypesRequest | 

try {
    $result = $apiInstance->availableTypes($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoomServiceApi->availableTypes: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\RoomServiceAvailableTypesRequest

Return type

\Alfaview\Model\RoomServiceAvailableTypesReply

Authorization

No authorization required

HTTP request headers

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

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

callList

\Alfaview\Model\RoomServiceRoomListReply callList($body)

list all rooms which are accessible by the current user

Example

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

$apiInstance = new Alfaview\Api\RoomServiceApi(
    // 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()
);
$body = new \Alfaview\Model\RoomServiceRoomListRequest(); // \Alfaview\Model\RoomServiceRoomListRequest | 

try {
    $result = $apiInstance->callList($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoomServiceApi->callList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\RoomServiceRoomListRequest

Return type

\Alfaview\Model\RoomServiceRoomListReply

Authorization

No authorization required

HTTP request headers

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

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

create

\Alfaview\Model\RoomServiceRoomCreateReply create($body)

creates or replaces all values

Example

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

$apiInstance = new Alfaview\Api\RoomServiceApi(
    // 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()
);
$body = new \Alfaview\Model\RoomServiceRoomCreateRequest(); // \Alfaview\Model\RoomServiceRoomCreateRequest | 

try {
    $result = $apiInstance->create($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoomServiceApi->create: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\RoomServiceRoomCreateRequest

Return type

\Alfaview\Model\RoomServiceRoomCreateReply

Authorization

No authorization required

HTTP request headers

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

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

createJoinLink

\Alfaview\Model\RoomServiceCreateJoinLinkReply createJoinLink($body)

creates a link to launch the client

Example

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

$apiInstance = new Alfaview\Api\RoomServiceApi(
    // 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()
);
$body = new \Alfaview\Model\RoomServiceCreateJoinLinkRequest(); // \Alfaview\Model\RoomServiceCreateJoinLinkRequest | 

try {
    $result = $apiInstance->createJoinLink($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoomServiceApi->createJoinLink: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\RoomServiceCreateJoinLinkRequest

Return type

\Alfaview\Model\RoomServiceCreateJoinLinkReply

Authorization

No authorization required

HTTP request headers

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

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

destroy

\Alfaview\Model\RoomServiceRoomDestroyReply destroy($body)

deletes room and kicks all users

Example

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

$apiInstance = new Alfaview\Api\RoomServiceApi(
    // 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()
);
$body = new \Alfaview\Model\RoomServiceRoomDestroyRequest(); // \Alfaview\Model\RoomServiceRoomDestroyRequest | 

try {
    $result = $apiInstance->destroy($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoomServiceApi->destroy: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\RoomServiceRoomDestroyRequest

Return type

\Alfaview\Model\RoomServiceRoomDestroyReply

Authorization

No authorization required

HTTP request headers

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

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

permissions

\Alfaview\Model\RoomServiceRoomPermissionsReply permissions($body)

Deprecated: use 'Permissions' call in the roomStateService

Example

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

$apiInstance = new Alfaview\Api\RoomServiceApi(
    // 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()
);
$body = new \Alfaview\Model\RoomServiceRoomPermissionsRequest(); // \Alfaview\Model\RoomServiceRoomPermissionsRequest | 

try {
    $result = $apiInstance->permissions($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoomServiceApi->permissions: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\RoomServiceRoomPermissionsRequest

Return type

\Alfaview\Model\RoomServiceRoomPermissionsReply

Authorization

No authorization required

HTTP request headers

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

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

sort

\Alfaview\Model\RoomServiceRoomSortReply sort($body)

changes the sorting of rooms

Example

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

$apiInstance = new Alfaview\Api\RoomServiceApi(
    // 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()
);
$body = new \Alfaview\Model\RoomServiceRoomSortRequest(); // \Alfaview\Model\RoomServiceRoomSortRequest | 

try {
    $result = $apiInstance->sort($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoomServiceApi->sort: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\RoomServiceRoomSortRequest

Return type

\Alfaview\Model\RoomServiceRoomSortReply

Authorization

No authorization required

HTTP request headers

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

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

status

\Alfaview\Model\RoomServiceRoomStatusReply status($body)

Deprecated: use 'Status' call in the roomStateService

Example

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

$apiInstance = new Alfaview\Api\RoomServiceApi(
    // 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()
);
$body = new \Alfaview\Model\RoomServiceRoomStatusRequest(); // \Alfaview\Model\RoomServiceRoomStatusRequest | 

try {
    $result = $apiInstance->status($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoomServiceApi->status: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\RoomServiceRoomStatusRequest

Return type

\Alfaview\Model\RoomServiceRoomStatusReply

Authorization

No authorization required

HTTP request headers

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

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

update

\Alfaview\Model\RoomServiceRoomUpdateReply update($body)

adds or overwrites all values

Example

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

$apiInstance = new Alfaview\Api\RoomServiceApi(
    // 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()
);
$body = new \Alfaview\Model\RoomServiceRoomUpdateRequest(); // \Alfaview\Model\RoomServiceRoomUpdateRequest | 

try {
    $result = $apiInstance->update($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoomServiceApi->update: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\RoomServiceRoomUpdateRequest

Return type

\Alfaview\Model\RoomServiceRoomUpdateReply

Authorization

No authorization required

HTTP request headers

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

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

Files

RoomServiceApi.md

Latest commit

History

RoomServiceApi.md

File metadata and controls

Alfaview\RoomServiceApi

availableTypes

Example

Parameters

Return type

Authorization

HTTP request headers

callList

Example

Parameters

Return type

Authorization

HTTP request headers

create

Example

Parameters

Return type

Authorization

HTTP request headers

createJoinLink

Example

Parameters

Return type

Authorization

HTTP request headers

destroy

Example

Parameters

Return type

Authorization

HTTP request headers

permissions

Example

Parameters

Return type

Authorization

HTTP request headers

sort

Example

Parameters

Return type

Authorization

HTTP request headers

status

Example

Parameters

Return type

Authorization

HTTP request headers

update

Example

Parameters

Return type

Authorization

HTTP request headers