Skip to content

feat(taskprocessing): add option for user-facing error message #452

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kyteinsky wants to merge 1 commit into from
+24 −4
Closed

feat(taskprocessing): add option for user-facing error message #452

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions nc_py_api/ex_app/providers/task_processing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,13 +186,23 @@ def report_result(
task_id: int,
output: dict[str, typing.Any] | None = None,
error_message: str | None = None,
user_facing_error_message: str | None = None,
) -> dict[str, typing.Any]:
"""Report result of the task processing to Nextcloud."""
"""Report result of the task processing to Nextcloud.

:param user_facing_error_message: An error message that will be shown to the user.
Available starting with Nextcloud 33. Added in nc_py_api 0.31.0.
"""
with contextlib.suppress(NextcloudException):
if r := self._session.ocs(
"POST",
f"/ocs/v2.php/taskprocessing/tasks_provider/{task_id}/result",
json={"taskId": task_id, "output": output, "errorMessage": error_message},
json={
"taskId": task_id,
"output": output,
"errorMessage": error_message,
"userFacingErrorMessage": user_facing_error_message,
},
):
return r
return {}
Expand Down Expand Up @@ -283,13 +293,23 @@ async def report_result(
task_id: int,
output: dict[str, typing.Any] | None = None,
error_message: str | None = None,
user_facing_error_message: str | None = None,
) -> dict[str, typing.Any]:
"""Report result of the task processing to Nextcloud."""
"""Report result of the task processing to Nextcloud.

:param user_facing_error_message: An error message that will be shown to the user.
Available starting with Nextcloud 33. Added in nc_py_api 0.31.0.
"""
with contextlib.suppress(NextcloudException):
if r := await self._session.ocs(
"POST",
f"/ocs/v2.php/taskprocessing/tasks_provider/{task_id}/result",
json={"taskId": task_id, "output": output, "errorMessage": error_message},
json={
"taskId": task_id,
"output": output,
"errorMessage": error_message,
"userFacingErrorMessage": user_facing_error_message,
},
):
return r
return {}
Loading