PHP Класс Scalr\Api\Service\User\V1beta0\Controller\Events

С версии: 5.4 (07.05.2015)

Автор: Vlad Dobrovolskiy ([email protected])

Наследование: extends Scalr\Api\Rest\Controller\ApiController

Открытые методы

Метод	Описание
createAction ( ) : Scalr\Api\DataType\ResultEnvelope	Creates new event in current scope
deleteAction ( string $eventId ) : Scalr\Api\DataType\ResultEnvelope	Deletes the event from the curent scope
describeAction ( )	Gets Events list
fetchAction ( string $eventId ) : Scalr\Api\DataType\ResultEnvelope	Fetches detailed info about the Event
getEvent ( string $eventId, boolean $restrictToCurrentScope = false ) : EventDefinition \| null	Gets event from database using User's Account
getScope ( ) : string	Gets current scope
modifyAction ( string $eventId ) : Scalr\Api\DataType\ResultEnvelope	Modifies event from current scope

Метод	Описание
getDefaultCriteria ( ) : array	Gets Default search criteria for the Account scope

Creates new event in current scope

public createAction ( ) : Scalr\Api\DataType\ResultEnvelope
Результат	Scalr\Api\DataType\ResultEnvelope

Deletes the event from the curent scope

public deleteAction ( string $eventId ) : Scalr\Api\DataType\ResultEnvelope
$eventId	string	Unique identifier of the Event
Результат	Scalr\Api\DataType\ResultEnvelope

Gets Events list

public describeAction ( )

Fetches detailed info about the Event

public fetchAction ( string $eventId ) : Scalr\Api\DataType\ResultEnvelope
$eventId	string	Unique identifier of the Event
Результат	Scalr\Api\DataType\ResultEnvelope

Gets event from database using User's Account

public getEvent ( string $eventId, boolean $restrictToCurrentScope = false ) : EventDefinition \| null
$eventId	string	The identifier of the Event
$restrictToCurrentScope	boolean	optional Whether it should additionally check that event corresponds to current scope
Результат	Scalr\Model\Entity\EventDefinition \| null	Returns Event Definition entity on success or NULL otherwise

Gets current scope

public getScope ( ) : string
Результат	string

Modifies event from current scope

public modifyAction ( string $eventId ) : Scalr\Api\DataType\ResultEnvelope
$eventId	string	Unique identifier of the Event
Результат	Scalr\Api\DataType\ResultEnvelope