PHP Class Scalr\Api\Service\User\V1beta0\Controller\Events

Since: 5.4 (07.05.2015)
Author: Vlad Dobrovolskiy ([email protected])
Inheritance: extends Scalr\Api\Rest\Controller\ApiController
Afficher le fichier Open project: scalr/scalr

Méthodes publiques

Méthode Description
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

Private Methods

Méthode Description
getDefaultCriteria ( ) : array Gets Default search criteria for the Account scope

Method Details

createAction() public méthode

Creates new event in current scope
public createAction ( ) : Scalr\Api\DataType\ResultEnvelope
Résultat Scalr\Api\DataType\ResultEnvelope

deleteAction() public méthode

Deletes the event from the curent scope
public deleteAction ( string $eventId ) : Scalr\Api\DataType\ResultEnvelope
$eventId string Unique identifier of the Event
Résultat Scalr\Api\DataType\ResultEnvelope

describeAction() public méthode

Gets Events list
public describeAction ( )

fetchAction() public méthode

Fetches detailed info about the Event
public fetchAction ( string $eventId ) : Scalr\Api\DataType\ResultEnvelope
$eventId string Unique identifier of the Event
Résultat Scalr\Api\DataType\ResultEnvelope

getEvent() public méthode

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
Résultat Scalr\Model\Entity\EventDefinition | null Returns Event Definition entity on success or NULL otherwise

getScope() public méthode

Gets current scope
public getScope ( ) : string
Résultat string

modifyAction() public méthode

Modifies event from current scope
public modifyAction ( string $eventId ) : Scalr\Api\DataType\ResultEnvelope
$eventId string Unique identifier of the Event
Résultat Scalr\Api\DataType\ResultEnvelope