Skip to content

Commit

Permalink
added new configuration option to Teams integration and updated docs …
Browse files Browse the repository at this point in the history
…around it
  • Loading branch information
albogdano committed Aug 7, 2024
1 parent d981897 commit 0ae5f30
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 4 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -597,6 +597,7 @@ scoold.password_auth_enabled = true
|`scoold.teams.post_to_space` <kbd>Pro</kbd><br>Default space on Scoold where questions created on Teams will be published. Set it to `workspace` for using the team's name. | ` ` | `String`|
|`scoold.teams.map_channels_to_spaces` <kbd>Pro</kbd><br>Enable/disable mapping of Teams channels to Scoold spaces. When enabled, will create a Scoold space for each Teams channel. | `false` | `Boolean`|
|`scoold.teams.map_workspaces_to_spaces` <kbd>Pro</kbd><br>Enable/disable mapping of Teams teams to Scoold spaces. When enabled, will create a Scoold space for each Teams team. | `true` | `Boolean`|
|`scoold.teams.private_teams_listing_allowed` <kbd>Pro</kbd><br>Enable/disable the listing of private teams on the Administration page when configuring notification webhooks for Scoold spaces. | `true` | `Boolean`|
|`scoold.teams.max_notification_webhooks` <kbd>Pro</kbd><br>The maximum number of incoming webhooks which can be created on Scoold. Each webhook links a Teams channel to Scoold. | `10` | `Integer`|
|`scoold.teams.default_title` <kbd>Pro</kbd><br>Default question title for questions created on Teams. | `A question from Microsoft Teams` | `String`|
|`scoold.teams.default_question_tags` <kbd>Pro</kbd><br>Default question tags for questions created on Teams (comma-separated list). | `via-teams` | `String`|
Expand Down
9 changes: 5 additions & 4 deletions docs/teams.html
Original file line number Diff line number Diff line change
Expand Up @@ -347,9 +347,9 @@ <h3 id="get-started"><span class="phl">Getting started</span></h3>
<span class="pam">
<b>1.</b> Visit the <a href="">Azure Poral</a>, navigate to "App registrations" and create a new
<b>multitenant</b> app registration called "Scoold" with the "Web" type selected under "Redirect URI".
If you choose to create a single tenant app registration, you must specify your tenant ID and add
explicit API permissions to your app registration
(<small class="grey-text"><code>Channel.ReadBasic.All, ChannelMessage.Read.All, Group.Read.All, User.Read, email, offline_access, openid, profile</code></small>).
If you choose to create a <b>single tenant</b> app registration, you must specify your tenant ID and explicitly
add the following API permissions to your app registration:
<small><code>Channel.ReadBasic.All, ChannelMessage.Read.All, Group.Read.All, User.ReadBasic.All, email, offline_access, openid, profile</code></small>.
<br><br>
In the "Certificates and Secrets" tab, create a new client secret and take note of the secret key.
Then go to the "Overview" tab and take note of the "Application (client) ID". Add these two values to
Expand Down Expand Up @@ -401,7 +401,8 @@ <h3 id="get-started"><span class="phl">Getting started</span></h3>
<li class="mvm mediumText"><span class="pam">
<b>6.</b> On the same page, click the "Download app package" button. Download the Zip file and sideload
it in Teams - go to the Teams app catalog and click "Upload a custom app > Upload for me or my teams"
at the bottom-left and select the Scoold.zip package.</span>
at the bottom-left and select the <code>Scoold.zip</code> package. <b>Repeat this step for every team
where you want to receive notifications from Scoold.</b></span>
</li>
<li class="mvm mediumText"><span class="pam">
<b>7.</b> Click the <b>"Add to team"</b> button and select the team/channel where you want the Scoold app installed.</span>
Expand Down
12 changes: 12 additions & 0 deletions src/main/java/com/erudika/scoold/ScooldConfig.java
Original file line number Diff line number Diff line change
Expand Up @@ -3048,6 +3048,18 @@ public boolean teamsMapWorkspacesToSpaces() {
return getConfigBoolean("teams.map_workspaces_to_spaces", true);
}

@Documented(position = 2781,
identifier = "teams.private_teams_listing_allowed",
value = "true",
type = Boolean.class,
category = "Microsoft Teams Integration",
tags = {"Pro"},
description = "Enable/disable the listing of private teams on the Administration page "
+ "when configuring notification webhooks for Scoold spaces.")
public boolean teamsPrivateTeamsListingAllowed() {
return getConfigBoolean("teams.private_teams_listing_allowed", true);
}

@Documented(position = 2790,
identifier = "teams.max_notification_webhooks",
value = "10",
Expand Down

0 comments on commit 0ae5f30

Please sign in to comment.