Skip to content
This repository was archived by the owner on Aug 18, 2020. It is now read-only.

English fix #5

Merged
merged 25 commits into from
Aug 11, 2019
Merged
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
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
Prev Previous commit
Next Next commit
Fixed typos in ...
development/Adding-a-new-platform-source.md
  • Loading branch information
DragonCoder01 committed Jul 31, 2019
commit 352ff4096e69f68cf7d2397908a528c0f996eee7
12 changes: 6 additions & 6 deletions development/Adding-a-new-platform-source.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
Thank you for help for the development of *Chat Overflow*.
While plugins live in their own project, source connections (e.g. to platform like Twitch or Discord) exist in the framework itself.
By this, we can make sure that everyone profits from the new possibilites.
Thank you for helping developing *Chat Overflow*.
While plugins live in their own project, source connections (e.g. to a platform like Twitch or Discord) exist in the framework itself.
By this measure, we can make sure that everyone profits from the same features.
This wiki entry tries to show you the different steps needed to implement a new connection.

1. Add new types to the API (Also register them in the requirement Input/Output section)
2. Create a new package in the framework services package and implement the source specific connector
3. Create a impl package and implement the types you added in the API
3. Create a impl package and implement the types you have added in the API

## Add new types to the API

Add all needed data transfer objects in `org.codeoverflow.chatoverflow.api.io.dto` and interfaces representing input / output to the correct API package. E.g. a chat input belongs to `org.codeoverflow.chatoverflow.api.io.input.chat` and should extend `ChatInput`.
Add all needed data transfer objects in `org.codeoverflow.chatoverflow.api.io.dto` and interfaces representing input / output to the correct API package. E.g., a chat input belongs to `org.codeoverflow.chatoverflow.api.io.input.chat` and should extend `ChatInput`.

We require you to also register your new type in the corresponding requirement class located in `org.codeoverflow.chatoverflow.api.plugin.configuration`. Yes, this step could be automated by using reflection. But by providing a clean interface to the plugin developer we protect type safety.
We require you to also register your new type in the corresponding requirement class located in `org.codeoverflow.chatoverflow.api.plugin.configuration`. Yes, this step could be automated by using reflection, but by providing a clean interface to the plugin developer we protect type safety.

## Add a new package and connector

Expand Down