Skip to content

Commit

Permalink
chore: Update README.md
Browse files Browse the repository at this point in the history
- list a new CAVEAT, is ref #119
- typo fix

Signed-off-by: Zweihorn <4863737+Zweihorn@users.noreply.github.com>
Signed-off-by: Richard Steinmetz <richard@steinmetz.cloud>
  • Loading branch information
Zweihorn authored and st3iny committed May 29, 2024
1 parent 22bb6e4 commit 1eb91d8
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ All boolean fields default to false if not specified
| calendar-resource:building:create | Create a building resource | `display_name` | `--address` `--description` `--wheelchair-accessible` | `calresources_building` | |
| calendar-resource:story:create | Create a story resource | `building_id` `display_name` | | `calresources_stories` | Needs an associated building id |
| calendar-resource:room:create | Create a room resource | `story_id` `uid` `display_name` `email` `room_type` | `--contact-person-user-id` `--capacity` `--room-number` `--has-phone` `--has-video-conferencing` `--has-tv` `--has-projector` `--has-whiteboard` `--wheelchair-accessible` | `calresources_rooms` | Needs an associated story id |
| calendar-resource:restriction:create | Create a restriction on a resource | `entity_type` `entity_id` `group_id` | | `calresources_restricits` | This restricts a resource to a group |
| calendar-resource:restriction:create | Create a restriction on a resource | `entity_type` `entity_id` `group_id` | | `calresources_restricts` | This restricts a resource to a group |
| calendar-resource:resource:create | Create a general resource | `uid` `building_id` `display_name` `email` `resource_type` | `--contact-person-user-id` | `calresources_resources` | Needs an associated building id |
| calendar-resource:vehicle:create | Create a vehicle resource | `uid` `building_id` `display_name` `email` `vehicle_type` `vehicle_make` `vehicle_model` | `--contact-person-user-id` `--is-electric` `--range` `--seating-capacity` | `calresources_vehicles` | Needs an associated building id |
| calendar-resource:resources:list | List all resources | | | | |
Expand All @@ -34,6 +34,9 @@ php occ calendar-resource:story:create 1 "2nd floor"
php occ calendar-resource:room:create --wheelchair-accessible=1 --capacity=25 --room-number=201 1 "demouser" "berlin_main_office" "room.berlin.main@spacexyz.com" "Shared office"
```

CAVEAT: Each room needs a unique email address. A common workaround is to use fake email addresses like "room0001@none".
Ref https://github.com/nextcloud/calendar_resource_management/issues/119#issuecomment-2114275319

The resources will be added to the calendar app via cron.

Any create command will return the ID of the created resource as the last line.
Expand Down

0 comments on commit 1eb91d8

Please sign in to comment.