OpenSlides/docs/interfaces/action-service.txt
Norman Jäckel 3751593841 Review.
2020-02-03 23:32:24 +01:00

26 lines
584 B
Plaintext

# Action Service Interface
Exception ActionException(message: string);
/**
* Executes multiple actions in the conext of the user given by the user_id.
* All actions are processed independently.
*
* TODO: Check if we need an interface or flag to process actions all together.
*
*
* @throws ActionException
*/
handle_request (payload: Action[], user_id: number): ActionResult[]
interface Action {
action: string;
data: object[]; # An array of action specific data. See JSON schema defintions.
}
interface ActionResult {
success: boolean;
message: string;
}