feat: scheduled message API #16297

miaulalala · 2025-11-10T06:34:46Z

☑️ Resolves

API part for #3954

🛠️ API Checklist

🚧 Tasks

...

🏁 Checklist

⛑️ Tests (unit and/or integration) are included or not possible
📘 API documentation in docs/ has been updated or is not required
🔖 Capability is added or not needed

Signed-off-by: Anna Larch <[email protected]>

lib/Migration/Version23000Date20251105125333.php

SystemKeeper · 2025-11-20T15:32:35Z

lib/Controller/ChatController.php

+	#[RequirePermission(permission: RequirePermission::CHAT)]
+	#[RequireReadWriteConversation]
+	#[ApiRoute(verb: 'GET', url: '/api/{apiVersion}/chat/{token}/schedule', requirements: [
+		'apiVersion' => '(v4)',


chat should be v1 still

SystemKeeper · 2025-11-20T15:41:04Z

lib/Controller/ChatController.php

+		'token' => '[a-z0-9]{4,30}',
+	])]
+	public function scheduledMessages(): DataResponse {
+		if ($this->room->getType() !== Room::TYPE_GROUP && $this->room->getType() !== Room::TYPE_ONE_TO_ONE) {


Why is TYPE_PUBLIC not supported?

Users that joined via public link (even when they're full users) are not persisted as participants

This is different, a room has TYPE_GROUP when no guest can join, but is has TYPE_PUBLIC if it's joinable by guests (but it means that there are still participants/users).

SystemKeeper · 2025-11-20T15:42:17Z

lib/Controller/ChatController.php

+		$data = $scheduledMessages;
+		return new DataResponse($data, Http::STATUS_CREATED);


Suggested change

$data = $scheduledMessages;

return new DataResponse($data, Http::STATUS_CREATED);

return new DataResponse($scheduledMessages, Http::STATUS_CREATED);

SystemKeeper · 2025-11-20T15:44:47Z

lib/Controller/ChatController.php

+	 * The author and timestamp are automatically set to the current user
+	 * and time.
+	 *
+	 * Required capability: `scheduled-messages`
+	 *
+	 * @param string $message the message to send
+	 * @param int $replyTo Parent id which this message is a reply to
+	 * @psalm-param non-negative-int $replyTo
+	 * @param bool $silent If sent silent the chat message will not create any notifications
+	 * @param string $threadTitle Only supported when not replying, when given will create a thread (requires `threads` capability)
+	 * @param int $threadId Thread id which this message is a reply to without quoting a specific message (ignored when $replyTo is given, also requires `threads` capability)
+	 * @return DataResponse<Http::STATUS_CREATED, TalkScheduledMessage, array{}>|DataResponse<Http::STATUS_BAD_REQUEST|Http::STATUS_NOT_FOUND|Http::STATUS_REQUEST_ENTITY_TOO_LARGE|Http::STATUS_TOO_MANY_REQUESTS, array{error: string}, array{}>
+	 *
+	 * 201: Message scheduled successfully
+	 * 400: Scheduled message is not possible
+	 * 404: Actor not found
+	 * 413: Message too long


Copied from setting?

SystemKeeper · 2025-11-20T15:44:57Z

lib/Controller/ChatController.php

+	 * @psalm-param non-negative-int $replyTo
+	 * @param bool $silent If sent silent the chat message will not create any notifications
+	 * @param string $threadTitle Only supported when not replying, when given will create a thread (requires `threads` capability)
+	 * @param int $threadId Thread id which this message is a reply to without quoting a specific message (ignored when $replyTo is given, also requires `threads` capability)


@param int $threadId Thread id [...] (ignored when $replyTo is given, also requires threads capability)

Wondering if that is correct? When we support replies, we also support replies in threads, or not?

copy pasted, need to look into it

SystemKeeper · 2025-11-20T15:54:26Z

lib/Controller/RoomController.php

 		protected IURLGenerator $url,
 		protected IL10N $l,
 		protected ThreadService $threadService,
+		protected ScheduledMessageService $scheduledMessageService,


Is it unused in room controller?

SystemKeeper · 2025-11-20T15:56:54Z

lib/Migration/Version23000Date20251105125333.php

+				'notnull' => true,
+			]);
+			$table->addColumn('send_at', Types::DATETIME, [
+				'notnull' => false,


Should this be true?

no, we can leave it nullable because then it's just a hop and a jump to supporting drafts

SystemKeeper · 2025-11-20T15:58:03Z

lib/Model/ScheduledMessage.php

+	protected string $message = '';
+	protected string $messageType = '';
+	protected ?string $metaData = null;
+	protected ?\DateTime $createdAt = null;


Can this be null, when the DB has it as nonnull => true?

yes, it can, but it would fail if I didn't set the param as new \DateTime() in the constructor

SystemKeeper · 2025-11-20T16:00:52Z

lib/Model/ScheduledMessage.php

+		$this->addType('room_id', Types::INTEGER);
+		$this->addType('actorId', Types::STRING);
+		$this->addType('actorType', Types::STRING);
+		$this->addType('threadId', Types::INTEGER);
+		$this->addType('parentId', Types::INTEGER);
+		$this->addType('message', Types::TEXT);
+		$this->addType('messageType', Types::STRING);
+		$this->addType('metaData', Types::TEXT);
+		$this->addType('sendAt', Types::DATETIME);
+		$this->addType('createdAt', Types::DATETIME);


Suggested change

$this->addType('room_id', Types::INTEGER);

$this->addType('actorId', Types::STRING);

$this->addType('actorType', Types::STRING);

$this->addType('threadId', Types::INTEGER);

$this->addType('parentId', Types::INTEGER);

$this->addType('message', Types::TEXT);

$this->addType('messageType', Types::STRING);

$this->addType('metaData', Types::TEXT);

$this->addType('sendAt', Types::DATETIME);

$this->addType('createdAt', Types::DATETIME);

$this->addType('room_id', Types::BIGINT);

$this->addType('actorId', Types::STRING);

$this->addType('actorType', Types::STRING);

$this->addType('threadId', Types::BIGINT);

$this->addType('parentId', Types::BIGINT);

$this->addType('message', Types::TEXT);

$this->addType('messageType', Types::STRING);

$this->addType('metaData', Types::TEXT);

$this->addType('sendAt', Types::DATETIME);

$this->addType('createdAt', Types::DATETIME);

Not sure if this also needs to be BIGINT as in the migration?

SystemKeeper · 2025-11-20T16:02:32Z

lib/Model/ScheduledMessage.php

+	#[\Override]
+	public function jsonSerialize(): array {
+		return [
+			'roomId' => $this->getRoomId(),


Do we need the ID here as well?

miaulalala · 2025-11-20T16:11:11Z

lib/Service/ScheduledMessageService.php

+	) {
+	}


Suggested change

) {

}

) {

$this->commentsManager = $commentsManager

}

feat: scheduled message API

93244b7

Signed-off-by: Anna Larch <[email protected]>

miaulalala added this to the 🍏 Next Major (33) milestone Nov 10, 2025

miaulalala self-assigned this Nov 10, 2025

miaulalala added 2. developing enhancement feature: chat 💬 Chat and system messages labels Nov 10, 2025

nickvergessen reviewed Nov 11, 2025

View reviewed changes

lib/Migration/Version23000Date20251105125333.php Outdated Show resolved Hide resolved

nickvergessen reviewed Nov 11, 2025

View reviewed changes

lib/Migration/Version23000Date20251105125333.php Outdated Show resolved Hide resolved

miaulalala added 13 commits November 11, 2025 17:38

fixup! feat: scheduled message API

6c73f2e

fixup! feat: scheduled message API

8b6bef7

fixup! feat: scheduled message API

7f5b01e

fixup! feat: scheduled message API

d48d0cb

fixup! feat: scheduled message API

c61bf1f

fixup! feat: scheduled message API

e220198

fixup! feat: scheduled message API

4c5ba55

fixup! feat: scheduled message API

0e3a39d

fixup! feat: scheduled message API

816ac31

fixup! feat: scheduled message API

277cc25

fixup! feat: scheduled message API

e8e6546

fixup! feat: scheduled message API

550ec35

fixup! feat: scheduled message API

8eb9fe8

SystemKeeper reviewed Nov 20, 2025

View reviewed changes

miaulalala commented Nov 20, 2025

View reviewed changes

		$data = $scheduledMessages;
		return new DataResponse($data, Http::STATUS_CREATED);

	$data = $scheduledMessages;
	return new DataResponse($data, Http::STATUS_CREATED);
	return new DataResponse($scheduledMessages, Http::STATUS_CREATED);

-	) {
-	}
+	) {
+	$this->commentsManager = $commentsManager
+	}

feat: scheduled message API #16297

Are you sure you want to change the base?

feat: scheduled message API #16297

Uh oh!

Conversation

miaulalala commented Nov 10, 2025

☑️ Resolves

🛠️ API Checklist

🚧 Tasks

🏁 Checklist

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants