OpenSlides/docs/interfaces/action-service.txt

26 lines
563 B
Plaintext

# Actions 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: Maybe we do not want to run them independently.
*
*
* @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;
}