Skip to content
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.

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

APP-3031 Activity API Documentation #202

Merged

Conversation

thibauult
Copy link
Member

@thibauult thibauult commented Sep 8, 2020

Reference documentation for the new Activity API. Added to file ./doc/activity.md

docs/activity.md Outdated
Using the Activity API will help you to make your bot interactions easier and faster to implement.
## Activity Registry
The main component for activities is certainly the [`ActivityRegistry`](../symphony-bdk-core/src/main/java/com/symphony/bdk/core/activity/ActivityRegistry.java).
This central component is used to either adding or retrieving activities.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to either add or retrieve? (sounds better to me, not 100% sure)

@thibauult thibauult marked this pull request as ready for review September 9, 2020 07:37
@thibauult thibauult requested a review from a team September 9, 2020 07:37
docs/activity.md Outdated
}
}
```
1. `/hello` is the command name
2. `true` means that the bot has to be mentioned
3. the command callback provides the

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably forgot to finish the sentence.

docs/activity.md Outdated
}
}
```
1. The `ActivityMatcher` here ensure that activity logic is triggered only when the form "**hello-form**" has been

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ActivityMatcher ensures that

docs/activity.md Outdated
}
}
```
1. The `ActivityMatcher` here ensure that activity logic is triggered only when the form "**hello-form**" has been
submitted from action button "**submit**"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

from the action button "submit"

@thibauult thibauult added the [type] documentation A documentation enhancement or update label Sep 9, 2020
@thibauult thibauult merged commit 791cd5a into finos:master Sep 9, 2020
@thibauult thibauult deleted the APP-3031_Activity-API-Documentation branch September 9, 2020 10:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[type] documentation A documentation enhancement or update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants