Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
RogerSelwyn committed Jan 10, 2023
1 parent bdb4e20 commit 3ff2927
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 5 deletions.
9 changes: 8 additions & 1 deletion docs/installation_and_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,8 @@ Key | Type | Required | Description
`query_sensors` | `list<query_sensors>` | `False` | List of query_sensor config entries
`status_sensors` | `list<status_sensors>` | `False` | List of status_sensor config entries. *Not for use on personal accounts*
`chat_sensors` | `list<chat_sensors>` | `False` | List of chat_sensor config entries. *Not for use on personal accounts*
`todo_sensors` | `object<query_sensors>` | `False` | To-Do sensor options
`todo_sensors` | `object<todo_sensors>` | `False` | To-Do sensor options
`auto_reply_sensors` | `object<auto_reply_sensors>` | `False` | Auto-reply sensor options

#### Secondary format

Expand Down Expand Up @@ -156,3 +157,9 @@ Key | Type | Required | Description
Key | Type | Required | Description
-- | -- | -- | --
`enabled` | `boolean` | `True` | True=Enables To-Do sensors, **False**=Disables To-Do sensors.

#### auto_reply_sensors

Key | Type | Required | Description
-- | -- | -- | --
`name` | `string` | `True` | The name of the sensor.
6 changes: 3 additions & 3 deletions docs/permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ Under "API Permissions" click Add a permission, then Microsoft Graph, then Deleg
| ToDo | Tasks.ReadWrite | Y | *Create, read, update, and delete user’s tasks and task lists* | |
| Group Calendar | Group.Read.All | | *Read all groups* | Not supported in legacy installs |
| Group Calendar | Group.ReadWrite.All | Y | *Read and write all groups* | Not supported in legacy installs |
| AutoReply | MailboxSettings.ReadWrite | Y | *Read and write user mailbox settings* | |
| AutoReply | MailboxSettings.ReadWrite | | *Read and write user mailbox settings* | |

**Note** It should be noted that these are the permissions that are requested at authentication time (as appropriate for each sensor configured). When `enable_update` is configured to `true` all the associated `ReadWrite` permissions are requested as well, however you do not need to add `ReadWrite` for any sensor type where you do not what update permissions, it will still act as a Read Only sensor. This excludes the AutoReply option which is only `ReadWrite` at this time since there is no associated sensor.
**Note** It should be noted that these are the permissions that are requested at authentication time (as appropriate for each sensor configured). When `enable_update` is configured to `true` all the associated `ReadWrite` permissions are requested as well, however you do not need to add `ReadWrite` for any sensor type where you do not what update permissions, it will still act as a Read Only sensor. This excludes the AutoReply option which is only `ReadWrite`.

For example, permissions as below (and with `enable_update` set to `true`) will create calendar sensors but not enable create/modify/remove/respond services, create chat sensors, and create auto reply enable/disable services:
For example, permissions as below (and with `enable_update` set to `true`) will create calendar sensors, create chat sensors, and create auto reply enable/disable services but will not enable create/modify/remove/respond services:
```json
"scope": [
"Calendars.Read",
Expand Down
5 changes: 5 additions & 0 deletions docs/sensor.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,8 @@ content: |-
- {{ task['subject'] }}
{% endfor %}{% endraw %}
```
## Auto Reply Sensor
Eventually this will show the current auto_reply settings, however at this time this functionality is awaiting release at the back-end.
The sensor does support the services for enabling and disabling auto-reply.
2 changes: 1 addition & 1 deletion docs/services.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ data:

## Auto reply Services

These services must be targeted at `email` or `query` sensors.
These services must be targeted at `auto_reply` sensors.

### o365.set_auto_reply
Schedule the auto reply - All parameters are shown in the available parameter list on the Developer Tools/Services tab.
Expand Down

0 comments on commit 3ff2927

Please sign in to comment.