Mirrors
/
nextcloud-spreed
mirror of https://github.com/nextcloud/spreed
3
0
Fork 0
Code Releases Activity
Browse Source

fix(docs): Update documentation with latest event changes 

Signed-off-by: Joas Schilling <coding@schilljs.com>
pull/10731/head
Joas Schilling 2 years ago
parent
9960b445b5
commit
cd90a40b78
No known key found for this signature in database GPG Key ID: 74434EFE0D2E2205
2 changed files with 172 additions and 34 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 204
      docs/events.md
  2. 2
      lib/Events/AttendeesEvent.php

204
docs/events.md
View File

@ -1,209 +1,347 @@
# PHP Events
Explanations:
* `Event class`: is the PHP class of the event object that is passed by the event
* `Event name`: refers to the PHP constant that contains the full name for the event. You should always use the constants instead of copying the value to avoid problems in the future. Most events have a `Before` and `After` event name. They behave the same and reflect if the event is triggered before or after the action described.
See the general [Nextcloud Developers - Events](https://docs.nextcloud.com/server/latest/developer_manual/basics/events.html) documentation for information how to listen to the events.
## Conversation related events
### Get conversations list
### Conversation list fetched
* Before event: `OCA\Talk\Events\BeforeRoomsFetchEvent`
* After event: *Not available*
* Since: 18.0.0
### Conversation created
* Before event: *Not available*
* After event: `OCA\Talk\Events\RoomCreatedEvent`
* Since: 18.0.0
### Conversation deleted
* Before event: `OCA\Talk\Events\BeforeRoomDeletedEvent`
* After event: `OCA\Talk\Events\RoomDeletedEvent`
* Since: 18.0.0
### Conversation modified
* Before event: `OCA\Talk\Events\BeforeRoomModifiedEvent`
* After event: `OCA\Talk\Events\RoomModifiedEvent`
* Since: 18.0.0
### Lobby modified
* Before event: `OCA\Talk\Events\BeforeLobbyModifiedEvent`
* After event: `OCA\Talk\Events\LobbyModifiedEvent`
* Since: 18.0.0
### Call ended for everyone
* Before event: `OCA\Talk\Events\BeforeCallEndedForEveryoneEvent`
* After event: `OCA\Talk\Events\CallEndedForEveryoneEvent`
* Since: 18.0.0
### Conversation password verify
Allows to verify a password and set a redirect URL for the invalid case
* Event: `OCA\Talk\Events\RoomPasswordVerifyEvent`
* Since: 18.0.0
### Deprecated events
These events were not using the typed-event mechanism and are therefore deprecated and will be removed in a future version.
#### Get conversations list
* Event class: `OCA\Talk\Events\UserEvent`
* Event name: `OCA\Talk\Controller\RoomController::EVENT_BEFORE_ROOMS_GET`
* Since: 8.0.0
* Deprecated: 18.0.0 - Use `OCA\Talk\Events\BeforeRoomsFetchEvent` instead
* Removed: 19.0.0
### Create conversation
#### Create conversation
* Event class: `OCA\Talk\Events\RoomEvent`
* Event name: `OCA\Talk\Room::EVENT_AFTER_ROOM_CREATE`
* Since: 8.0.0
* Deprecated: 18.0.0 - Use `OCA\Talk\Events\RoomCreatedEvent` instead
* Removed: 19.0.0
### Create token for conversation
#### Create token for conversation
* Event class: `OCA\Talk\Events\CreateRoomTokenEvent`
* Event name: `OCA\Talk\Manager::EVENT_TOKEN_GENERATE`
* Since: 8.0.0
* Removed: 11.0.0
### Set name
#### Set name
* Event class: `OCA\Talk\Events\ModifyRoomEvent`
* Before event name: `OCA\Talk\Room::EVENT_BEFORE_NAME_SET`
* After event name: `OCA\Talk\Room::EVENT_AFTER_NAME_SET`
* Since: 8.0.0
* Deprecated: 18.0.0 - Use `OCA\Talk\Events\BeforeRoomModifiedEvent` and `OCA\Talk\Events\RoomModifiedEvent` instead
* Removed: 19.0.0
### Set password
#### Set password
* Event class: `OCA\Talk\Events\ModifyRoomEvent`
- No old value is provided
* Before event name: `OCA\Talk\Room::EVENT_BEFORE_PASSWORD_SET`
* After event name: `OCA\Talk\Room::EVENT_AFTER_PASSWORD_SET`
* Since: 8.0.0
* Deprecated: 18.0.0 - Use `OCA\Talk\Events\BeforeRoomModifiedEvent` and `OCA\Talk\Events\RoomModifiedEvent` instead
* Removed: 19.0.0
### Set type
#### Set type
* Event class: `OCA\Talk\Events\ModifyRoomEvent`
* Before event name: `OCA\Talk\Room::EVENT_BEFORE_TYPE_SET`
* After event name: `OCA\Talk\Room::EVENT_AFTER_TYPE_SET`
* Since: 8.0.0
* Deprecated: 18.0.0 - Use `OCA\Talk\Events\BeforeRoomModifiedEvent` and `OCA\Talk\Events\RoomModifiedEvent` instead
* Removed: 19.0.0
### Set read-only
#### Set read-only
* Event class: `OCA\Talk\Events\ModifyRoomEvent`
* Before event name: `OCA\Talk\Room::EVENT_BEFORE_READONLY_SET`
* After event name: `OCA\Talk\Room::EVENT_AFTER_READONLY_SET`
* Since: 8.0.0
* Deprecated: 18.0.0 - Use `OCA\Talk\Events\BeforeRoomModifiedEvent` and `OCA\Talk\Events\RoomModifiedEvent` instead
* Removed: 19.0.0
### Set listable
#### Set listable
* Event class: `OCA\Talk\Events\ModifyRoomEvent`
* Before event name: `OCA\Talk\Room::EVENT_BEFORE_LISTABLE_SET`
* After event name: `OCA\Talk\Room::EVENT_AFTER_LISTABLE_SET`
* Since: 11.0.0
* Deprecated: 18.0.0 - Use `OCA\Talk\Events\BeforeRoomModifiedEvent` and `OCA\Talk\Events\RoomModifiedEvent` instead
* Removed: 19.0.0
### Set lobby
#### Set lobby
* Event class: `OCA\Talk\Events\ModifyLobbyEvent`
* Before event name: `OCA\Talk\Room::EVENT_BEFORE_LOBBY_STATE_SET`
* After event name: `OCA\Talk\Room::EVENT_AFTER_LOBBY_STATE_SET`
* Since: 8.0.0
* Deprecated: 18.0.0 - Use `OCA\Talk\Events\BeforeRoomModifiedEvent` and `OCA\Talk\Events\RoomModifiedEvent` instead
* Removed: 19.0.0
### Clean up guests
#### Clean up guests
* Event class: `OCA\Talk\Events\RoomEvent`
* Before event name: `OCA\Talk\Room::EVENT_BEFORE_GUESTS_CLEAN`
* After event name: `OCA\Talk\Room::EVENT_AFTER_GUESTS_CLEAN`
* Since: 8.0.0
* Deprecated: 18.0.0 - Use `OCA\Talk\Events\BeforeGuestsCleanedUpEvent` and `OCA\Talk\Events\GuestsCleanedUpEvent` instead
* Removed: 19.0.0
### Verify password
#### Verify password
* Event class: `OCA\Talk\Events\VerifyRoomPasswordEvent`
* Event name: `OCA\Talk\Room::EVENT_PASSWORD_VERIFY`
* Since: 8.0.0
* Deprecated: 18.0.0 - Use `OCA\Talk\Events\RoomPasswordVerifyEvent` instead
* Removed: 19.0.0
### Delete conversation
#### Delete conversation
* Event class: `OCA\Talk\Events\RoomEvent`
* Before event name: `OCA\Talk\Room::EVENT_BEFORE_ROOM_DELETE`
* After event name: `OCA\Talk\Room::EVENT_AFTER_ROOM_DELETE`
* Since: 8.0.0
* Deprecated: 18.0.0 - Use `OCA\Talk\Events\BeforeRoomDeletedEvent` and `OCA\Talk\Events\RoomDeletedEvent` instead
* Removed: 19.0.0
## Participant related events
### Add participants
### Attendees added
* Before event: *Not available*
* After event: `OCA\Talk\Events\AttendeesAddedEvent`
* Since: 12.0.0
### Attendees removed
* Before event: *Not available*
* After event: `OCA\Talk\Events\AttendeesRemovedEvent`
* Since: 12.0.0
### Federated user joined a conversation
* Before event: `OCA\Talk\Events\BeforeFederatedUserJoinedRoomEvent`
* After event: `OCA\Talk\Events\FederatedUserJoinedRoomEvent`
* Since: 18.0.0
### Guests cleaned up
Remove guests without an active session
* Before event: `OCA\Talk\Events\BeforeGuestsCleanedUpEvent`
* After event: `OCA\Talk\Events\GuestsCleanedUpEvent`
* Since: 18.0.0
### Deprecated events
These events were not using the typed-event mechanism and are therefore deprecated and will be removed in a future version.
#### Add participants
* Event class: `OCA\Talk\Events\AddParticipantsEvent`
* Before event name: `OCA\Talk\Room::EVENT_BEFORE_USERS_ADD`
* After event name: `OCA\Talk\Room::EVENT_AFTER_USERS_ADD`
* Since: 8.0.0
* Deprecated: 18.0.0
### Add email
#### Add email
* Event class: `OCA\Talk\Events\AddEmailEvent`
* Before event name: `OCA\Talk\GuestManager::EVENT_BEFORE_EMAIL_INVITE`
* After event name: `OCA\Talk\GuestManager::EVENT_AFTER_EMAIL_INVITE`
* Since: 8.0.0
* Deprecated: 18.0.0
### Remove participant by session
#### Remove participant by session
* Event class: `OCA\Talk\Events\RemoveParticipantEvent`
* Event name: `OCA\Talk\GuestManager::EVENT_AFTER_NAME_UPDATE`
* Since: 8.0.0
* Deprecated: 18.0.0
### Set participant type for user
#### Set participant type for user
* Event class: `OCA\Talk\Events\ModifyParticipantEvent`
* Before event name: `OCA\Talk\Room::EVENT_BEFORE_PARTICIPANT_TYPE_SET`
* After event name: `OCA\Talk\Room::EVENT_AFTER_PARTICIPANT_TYPE_SET`
* Since: 8.0.0
* Deprecated: 18.0.0
### Join a conversation as user (Connect)
#### Join a conversation as user (Connect)
* Event class: `OCA\Talk\Events\JoinRoomUserEvent`
* Before event name: `OCA\Talk\Room::EVENT_BEFORE_ROOM_CONNECT`
* After event name: `OCA\Talk\Room::EVENT_AFTER_ROOM_CONNECT`
* Since: 8.0.0
* Deprecated: 18.0.0
### Join a conversation as guest (Connect)
#### Join a conversation as guest (Connect)
* Event class: `OCA\Talk\Events\JoinRoomGuestEvent`
* Before event name: `OCA\Talk\Room::EVENT_BEFORE_GUEST_CONNECT`
* After event name: `OCA\Talk\Room::EVENT_AFTER_GUEST_CONNECT`
* Since: 8.0.0
* Deprecated: 18.0.0
### Join a call
#### Join a call
* Event class: `OCA\Talk\Events\ModifyParticipantEvent`
* Before event name: `OCA\Talk\Room::EVENT_BEFORE_SESSION_JOIN_CALL`
* After event name: `OCA\Talk\Room::EVENT_AFTER_SESSION_JOIN_CALL`
* Since: 8.0.0
* Deprecated: 18.0.0
### Leave a call
#### Leave a call
* Event class: `OCA\Talk\Events\ModifyParticipantEvent`
* Before event name: `OCA\Talk\Room::EVENT_BEFORE_SESSION_LEAVE_CALL`
* After event name: `OCA\Talk\Room::EVENT_AFTER_SESSION_LEAVE_CALL`
* Since: 8.0.0
* Deprecated: 18.0.0
### Leave a conversation (Disconnect)
#### Leave a conversation (Disconnect)
* Event class: `OCA\Talk\Events\ParticipantEvent`
* Before event name: `OCA\Talk\Room::EVENT_BEFORE_ROOM_DISCONNECT`
* After event name: `OCA\Talk\Room::EVENT_AFTER_ROOM_DISCONNECT`
* Since: 8.0.0
* Deprecated: 18.0.0
### Remove user
#### Remove user
* Event class: `OCA\Talk\Events\RemoveUserEvent`
* Before event name: `OCA\Talk\Room::EVENT_BEFORE_USER_REMOVE`
* After event name: `OCA\Talk\Room::EVENT_AFTER_USER_REMOVE`
* Since: 8.0.0
* Deprecated: 18.0.0
### Remove participant by session
#### Remove participant by session
* Event class: `OCA\Talk\Events\RemoveParticipantEvent`
* Before event name: `OCA\Talk\Room::EVENT_BEFORE_PARTICIPANT_REMOVE`
* After event name: `OCA\Talk\Room::EVENT_AFTER_PARTICIPANT_REMOVE`
* Since: 8.0.0
* Deprecated: 18.0.0
## Chat related events
### System message
### Deprecated events
These events were not using the typed-event mechanism and are therefore deprecated and will be removed in a future version.
#### System message
* Event class: `OCA\Talk\Events\ChatEvent`
* Before event name: `OCA\Talk\Chat\ChatManager::EVENT_BEFORE_SYSTEM_MESSAGE_SEND`
* After event name: `OCA\Talk\Chat\ChatManager::EVENT_AFTER_SYSTEM_MESSAGE_SEND`
* Since: 8.0.0
* Deprecated: 18.0.0
### Post chat message
#### Post chat message
* Event class: `OCA\Talk\Events\ChatEvent`
* Before event name: `OCA\Talk\Chat\ChatManager::EVENT_BEFORE_MESSAGE_SEND`
* After event name: `OCA\Talk\Chat\ChatManager::EVENT_AFTER_MESSAGE_SEND`
* Since: 8.0.0
* Deprecated: 18.0.0
### Parse chat message
#### Parse chat message
* Event class: `OCA\Talk\Events\ChatMessageEvent`
* Event name: `OCA\Talk\Chat\MessageParser::EVENT_MESSAGE_PARSE`
* Since: 8.0.0
* Deprecated: 18.0.0
### Command execution for apps
#### Command execution for apps
* Event class: `OCA\Talk\Events\CommandEvent`
* Event name: `OCA\Talk\Chat\Command\Executor::EVENT_APP_EXECUTE`
* Since: 8.0.0
* Deprecated: 18.0.0
## Other events
### Signaling backend
### Deprecated events
These events were not using the typed-event mechanism and are therefore deprecated and will be removed in a future version.
#### Signaling backend
* Event class: `OCA\Talk\Events\SignalingEvent`
* Event name: `OCA\Talk\Controller\SignalingController::EVENT_BACKEND_SIGNALING_ROOMS`
* Since: 8.0.0
* Deprecated: 18.0.0
### Get conversation properties for signaling
#### Get conversation properties for signaling
* Event class: `OCA\Talk\Events\SignalingRoomPropertiesEvent`
* Event name: `OCA\Talk\Room::EVENT_BEFORE_SIGNALING_PROPERTIES`
* Since: 8.0.5
* Deprecated: 18.0.0
## Inbound events to invoke Talk
### Bot install
Dispatch this event in your app to install a bot on this server
* Event: `OCA\Talk\Events\BotInstallEvent`
* Since: 17.0.0
### Bot uninstall
Dispatch this event in your app to install a bot on this server
* Event: `OCA\Talk\Events\BotUninstallEvent`
* Since: 17.0.0

2
lib/Events/AttendeesEvent.php
View File

@ -26,7 +26,7 @@ namespace OCA\Talk\Events;
use OCA\Talk\Model\Attendee;
use OCA\Talk\Room;
class AttendeesEvent extends RoomEvent {
abstract class AttendeesEvent extends RoomEvent {
public function __construct(
Room $room,
protected array $attendees,

Write Preview
Loading…
Cancel
Save