nextcloud / nextcloud/documentation

Activity API docs

Open
#2,150 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

1. to develop feature: activity and notification manual: developer
Dominant language
JavaScript
Stars
628
Forks
2.5k
Avg merge
2d 11h
Merged PRs (30d)
135

Description

Hello,

I'm trying to implement integration with the activity app. The documentation for creating activities thankfully provides the API methods that I can use and that I need an implementation of ISetting, but no explanation what those APIs are used for. What is the difference between an activity subject and an activity object? What should usually be part of the message?

Hopefully this can be cleared up in the docs. 💙

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with docs/create.md, linked in the issue, and review how it currently describes creating activities and ISetting. Clarify the difference between an activity subject and object, and explain what normally belongs in the message. Done means the API concepts and message guidance are understandable without outside clarification.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.