From b1e8ea2b60116e9e5f6a056010a1a57740aaf01a Mon Sep 17 00:00:00 2001 From: erikjohnston Date: Fri, 27 Oct 2023 09:05:11 +0000 Subject: deploy: c02406ac711095eedbeeff229af8e368f77196aa --- develop/404.html | 2 +- develop/CAPTCHA_SETUP.html | 2 +- develop/admin_api/account_validity.html | 2 +- develop/admin_api/event_reports.html | 2 +- develop/admin_api/experimental_features.html | 2 +- develop/admin_api/media_admin_api.html | 2 +- develop/admin_api/purge_history_api.html | 2 +- develop/admin_api/register_api.html | 2 +- develop/admin_api/room_membership.html | 2 +- develop/admin_api/rooms.html | 2 +- develop/admin_api/server_notices.html | 2 +- develop/admin_api/statistics.html | 2 +- develop/admin_api/user_admin_api.html | 2 +- develop/admin_api/version_api.html | 2 +- develop/application_services.html | 2 +- develop/auth_chain_difference_algorithm.html | 2 +- develop/code_style.html | 2 +- develop/consent_tracking.html | 2 +- develop/delegate.html | 2 +- develop/deprecation_policy.html | 2 +- develop/development/cas.html | 2 +- develop/development/contributing_guide.html | 2 +- develop/development/database_schema.html | 2 +- develop/development/demo.html | 2 +- develop/development/dependencies.html | 2 +- develop/development/experimental_features.html | 2 +- develop/development/git.html | 2 +- .../development/internal_documentation/index.html | 2 +- develop/development/releases.html | 2 +- develop/development/reviews.html | 2 +- develop/development/room-dag-concepts.html | 2 +- develop/development/saml.html | 2 +- .../synapse_architecture/cancellation.html | 2 +- .../synapse_architecture/faster_joins.html | 2 +- .../development/synapse_architecture/streams.html | 2 +- develop/federate.html | 2 +- develop/index.html | 2 +- develop/jwt.html | 2 +- develop/log_contexts.html | 2 +- develop/manhole.html | 2 +- develop/media_repository.html | 2 +- develop/message_retention_policies.html | 2 +- develop/metrics-howto.html | 2 +- develop/modules/account_data_callbacks.html | 6 +- develop/modules/account_validity_callbacks.html | 2 +- ...add_extra_fields_to_client_events_unsigned.html | 210 +++++++++++++++++++++ .../background_update_controller_callbacks.html | 2 +- develop/modules/index.html | 2 +- .../modules/password_auth_provider_callbacks.html | 2 +- develop/modules/porting_legacy_module.html | 6 +- develop/modules/presence_router_callbacks.html | 2 +- develop/modules/spam_checker_callbacks.html | 2 +- develop/modules/third_party_rules_callbacks.html | 2 +- develop/modules/writing_a_module.html | 2 +- develop/openid.html | 2 +- develop/opentracing.html | 2 +- .../running_synapse_on_single_board_computers.html | 2 +- develop/password_auth_providers.html | 2 +- develop/postgres.html | 2 +- develop/print.html | 23 ++- develop/replication.html | 2 +- develop/reverse_proxy.html | 2 +- develop/room_and_user_statistics.html | 2 +- develop/searchindex.js | 2 +- develop/searchindex.json | 2 +- develop/server_notices.html | 2 +- develop/setup/forward_proxy.html | 2 +- develop/setup/installation.html | 2 +- develop/setup/turn/coturn.html | 2 +- develop/setup/turn/eturnal.html | 2 +- develop/sso_mapping_providers.html | 2 +- develop/structured_logging.html | 2 +- develop/synctl_workers.html | 2 +- develop/systemd-with-workers/index.html | 2 +- develop/tcp_replication.html | 2 +- develop/templates.html | 2 +- develop/turn-howto.html | 2 +- develop/upgrade.html | 2 +- .../admin_api/background_updates.html | 2 +- .../usage/administration/admin_api/federation.html | 2 +- develop/usage/administration/admin_api/index.html | 2 +- .../admin_api/registration_tokens.html | 2 +- develop/usage/administration/admin_faq.html | 2 +- .../administration/database_maintenance_tools.html | 2 +- develop/usage/administration/index.html | 2 +- .../reporting_homeserver_usage_statistics.html | 2 +- .../usage/administration/monthly_active_users.html | 2 +- develop/usage/administration/request_log.html | 2 +- develop/usage/administration/state_groups.html | 2 +- ...derstanding_synapse_through_grafana_graphs.html | 2 +- .../administration/useful_sql_for_admins.html | 2 +- .../usage/configuration/config_documentation.html | 2 +- .../configuration/homeserver_sample_config.html | 2 +- develop/usage/configuration/index.html | 2 +- .../usage/configuration/logging_sample_config.html | 2 +- .../configuration/user_authentication/index.html | 2 +- .../user_authentication/refresh_tokens.html | 2 +- .../user_authentication/single_sign_on/cas.html | 2 +- .../user_authentication/single_sign_on/index.html | 2 +- .../user_authentication/single_sign_on/saml.html | 2 +- develop/user_directory.html | 2 +- develop/welcome_and_overview.html | 2 +- develop/workers.html | 2 +- 103 files changed, 337 insertions(+), 106 deletions(-) create mode 100644 develop/modules/add_extra_fields_to_client_events_unsigned.html (limited to 'develop') diff --git a/develop/404.html b/develop/404.html index 399c3a5829..9d2b63f465 100644 --- a/develop/404.html +++ b/develop/404.html @@ -77,7 +77,7 @@ diff --git a/develop/CAPTCHA_SETUP.html b/develop/CAPTCHA_SETUP.html index a0050f43fb..879a3289f3 100644 --- a/develop/CAPTCHA_SETUP.html +++ b/develop/CAPTCHA_SETUP.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/account_validity.html b/develop/admin_api/account_validity.html index f6552ca2df..3f97284c26 100644 --- a/develop/admin_api/account_validity.html +++ b/develop/admin_api/account_validity.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/event_reports.html b/develop/admin_api/event_reports.html index aabec67f60..fd2121e896 100644 --- a/develop/admin_api/event_reports.html +++ b/develop/admin_api/event_reports.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/experimental_features.html b/develop/admin_api/experimental_features.html index 88b3e9aa0e..00b32d6429 100644 --- a/develop/admin_api/experimental_features.html +++ b/develop/admin_api/experimental_features.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/media_admin_api.html b/develop/admin_api/media_admin_api.html index 89249d8c2c..0180aa291e 100644 --- a/develop/admin_api/media_admin_api.html +++ b/develop/admin_api/media_admin_api.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/purge_history_api.html b/develop/admin_api/purge_history_api.html index 9b5e258b90..c40eedfa0d 100644 --- a/develop/admin_api/purge_history_api.html +++ b/develop/admin_api/purge_history_api.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/register_api.html b/develop/admin_api/register_api.html index b3e4cbe917..af44e600ef 100644 --- a/develop/admin_api/register_api.html +++ b/develop/admin_api/register_api.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/room_membership.html b/develop/admin_api/room_membership.html index b5b3e76b61..1db4204bba 100644 --- a/develop/admin_api/room_membership.html +++ b/develop/admin_api/room_membership.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/rooms.html b/develop/admin_api/rooms.html index fe246b4041..dcc6af660a 100644 --- a/develop/admin_api/rooms.html +++ b/develop/admin_api/rooms.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/server_notices.html b/develop/admin_api/server_notices.html index fdb9641d8c..8f2b92417f 100644 --- a/develop/admin_api/server_notices.html +++ b/develop/admin_api/server_notices.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/statistics.html b/develop/admin_api/statistics.html index 323a1165e1..2b5f94d187 100644 --- a/develop/admin_api/statistics.html +++ b/develop/admin_api/statistics.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/user_admin_api.html b/develop/admin_api/user_admin_api.html index 9c991b4542..2a473f2bee 100644 --- a/develop/admin_api/user_admin_api.html +++ b/develop/admin_api/user_admin_api.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/version_api.html b/develop/admin_api/version_api.html index a48a7cd1ad..d2b3817223 100644 --- a/develop/admin_api/version_api.html +++ b/develop/admin_api/version_api.html @@ -76,7 +76,7 @@ diff --git a/develop/application_services.html b/develop/application_services.html index 3d7dd407d8..910777f19e 100644 --- a/develop/application_services.html +++ b/develop/application_services.html @@ -76,7 +76,7 @@ diff --git a/develop/auth_chain_difference_algorithm.html b/develop/auth_chain_difference_algorithm.html index d7d451fcfd..1acefd678e 100644 --- a/develop/auth_chain_difference_algorithm.html +++ b/develop/auth_chain_difference_algorithm.html @@ -76,7 +76,7 @@ diff --git a/develop/code_style.html b/develop/code_style.html index 02d716dbf6..70323b243f 100644 --- a/develop/code_style.html +++ b/develop/code_style.html @@ -76,7 +76,7 @@ diff --git a/develop/consent_tracking.html b/develop/consent_tracking.html index 7308c01531..abe5ded164 100644 --- a/develop/consent_tracking.html +++ b/develop/consent_tracking.html @@ -76,7 +76,7 @@ diff --git a/develop/delegate.html b/develop/delegate.html index fa99c564b2..20f1fcdd3f 100644 --- a/develop/delegate.html +++ b/develop/delegate.html @@ -76,7 +76,7 @@ diff --git a/develop/deprecation_policy.html b/develop/deprecation_policy.html index 95742bacae..cf8713a6b4 100644 --- a/develop/deprecation_policy.html +++ b/develop/deprecation_policy.html @@ -76,7 +76,7 @@ diff --git a/develop/development/cas.html b/develop/development/cas.html index ae35250574..0175828eac 100644 --- a/develop/development/cas.html +++ b/develop/development/cas.html @@ -76,7 +76,7 @@ diff --git a/develop/development/contributing_guide.html b/develop/development/contributing_guide.html index 4dbea6b43d..f1c7b71fbe 100644 --- a/develop/development/contributing_guide.html +++ b/develop/development/contributing_guide.html @@ -76,7 +76,7 @@ diff --git a/develop/development/database_schema.html b/develop/development/database_schema.html index 8dffa04d7a..0aeae50c98 100644 --- a/develop/development/database_schema.html +++ b/develop/development/database_schema.html @@ -76,7 +76,7 @@ diff --git a/develop/development/demo.html b/develop/development/demo.html index 2d4754ff33..ce8e259aa1 100644 --- a/develop/development/demo.html +++ b/develop/development/demo.html @@ -76,7 +76,7 @@ diff --git a/develop/development/dependencies.html b/develop/development/dependencies.html index f44f2db144..b4aecc2a51 100644 --- a/develop/development/dependencies.html +++ b/develop/development/dependencies.html @@ -76,7 +76,7 @@ diff --git a/develop/development/experimental_features.html b/develop/development/experimental_features.html index 98974dd4cd..bf06f62e93 100644 --- a/develop/development/experimental_features.html +++ b/develop/development/experimental_features.html @@ -76,7 +76,7 @@ diff --git a/develop/development/git.html b/develop/development/git.html index a6a9a322e6..34b9fb0ee3 100644 --- a/develop/development/git.html +++ b/develop/development/git.html @@ -76,7 +76,7 @@ diff --git a/develop/development/internal_documentation/index.html b/develop/development/internal_documentation/index.html index 10f4a067e1..51262280eb 100644 --- a/develop/development/internal_documentation/index.html +++ b/develop/development/internal_documentation/index.html @@ -76,7 +76,7 @@ diff --git a/develop/development/releases.html b/develop/development/releases.html index 4e96f192c1..30981828af 100644 --- a/develop/development/releases.html +++ b/develop/development/releases.html @@ -76,7 +76,7 @@ diff --git a/develop/development/reviews.html b/develop/development/reviews.html index ee932ce705..c30202f86f 100644 --- a/develop/development/reviews.html +++ b/develop/development/reviews.html @@ -76,7 +76,7 @@ diff --git a/develop/development/room-dag-concepts.html b/develop/development/room-dag-concepts.html index eaa06b291c..099a644e13 100644 --- a/develop/development/room-dag-concepts.html +++ b/develop/development/room-dag-concepts.html @@ -76,7 +76,7 @@ diff --git a/develop/development/saml.html b/develop/development/saml.html index 3a2e8ac490..3e3b9fb124 100644 --- a/develop/development/saml.html +++ b/develop/development/saml.html @@ -76,7 +76,7 @@ diff --git a/develop/development/synapse_architecture/cancellation.html b/develop/development/synapse_architecture/cancellation.html index 8f7d25bb88..097990e4a2 100644 --- a/develop/development/synapse_architecture/cancellation.html +++ b/develop/development/synapse_architecture/cancellation.html @@ -76,7 +76,7 @@ diff --git a/develop/development/synapse_architecture/faster_joins.html b/develop/development/synapse_architecture/faster_joins.html index dcb761384f..f43f49a007 100644 --- a/develop/development/synapse_architecture/faster_joins.html +++ b/develop/development/synapse_architecture/faster_joins.html @@ -76,7 +76,7 @@ diff --git a/develop/development/synapse_architecture/streams.html b/develop/development/synapse_architecture/streams.html index b8b91f66a9..b940cdf006 100644 --- a/develop/development/synapse_architecture/streams.html +++ b/develop/development/synapse_architecture/streams.html @@ -76,7 +76,7 @@ diff --git a/develop/federate.html b/develop/federate.html index d49f9a2993..07c3688f0f 100644 --- a/develop/federate.html +++ b/develop/federate.html @@ -76,7 +76,7 @@ diff --git a/develop/index.html b/develop/index.html index 3afa750990..8f09ac3823 100644 --- a/develop/index.html +++ b/develop/index.html @@ -76,7 +76,7 @@ diff --git a/develop/jwt.html b/develop/jwt.html index 4e922b3892..8c9cd41a4c 100644 --- a/develop/jwt.html +++ b/develop/jwt.html @@ -76,7 +76,7 @@ diff --git a/develop/log_contexts.html b/develop/log_contexts.html index 75e0533a8b..76f2b55e6a 100644 --- a/develop/log_contexts.html +++ b/develop/log_contexts.html @@ -76,7 +76,7 @@ diff --git a/develop/manhole.html b/develop/manhole.html index 60bc9432b6..a4c0e72968 100644 --- a/develop/manhole.html +++ b/develop/manhole.html @@ -76,7 +76,7 @@ diff --git a/develop/media_repository.html b/develop/media_repository.html index d0e87c9069..31670d4b56 100644 --- a/develop/media_repository.html +++ b/develop/media_repository.html @@ -76,7 +76,7 @@ diff --git a/develop/message_retention_policies.html b/develop/message_retention_policies.html index aee95664d9..ce9333e698 100644 --- a/develop/message_retention_policies.html +++ b/develop/message_retention_policies.html @@ -76,7 +76,7 @@ diff --git a/develop/metrics-howto.html b/develop/metrics-howto.html index c43ce93d88..ab771f6f4a 100644 --- a/develop/metrics-howto.html +++ b/develop/metrics-howto.html @@ -76,7 +76,7 @@ diff --git a/develop/modules/account_data_callbacks.html b/develop/modules/account_data_callbacks.html index c50b180e92..9004174bb1 100644 --- a/develop/modules/account_data_callbacks.html +++ b/develop/modules/account_data_callbacks.html @@ -76,7 +76,7 @@ @@ -245,7 +245,7 @@ class CustomAccountDataModule: -
@@ -257,7 +257,7 @@ class CustomAccountDataModule: - diff --git a/develop/modules/account_validity_callbacks.html b/develop/modules/account_validity_callbacks.html index 543e8d6634..eb23bf6f0b 100644 --- a/develop/modules/account_validity_callbacks.html +++ b/develop/modules/account_validity_callbacks.html @@ -76,7 +76,7 @@ diff --git a/develop/modules/add_extra_fields_to_client_events_unsigned.html b/develop/modules/add_extra_fields_to_client_events_unsigned.html new file mode 100644 index 0000000000..b23940d4bd --- /dev/null +++ b/develop/modules/add_extra_fields_to_client_events_unsigned.html @@ -0,0 +1,210 @@ + + + + + + Add extra fields to client events unsigned section callbacks - Synapse + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + + +
+
+ +
+ +
+ +

Add extra fields to client events unsigned section callbacks

+

First introduced in Synapse v1.96.0

+

This callback allows modules to add extra fields to the unsigned section of +events when they get sent down to clients.

+

These get called every time an event is to be sent to clients, so care should +be taken to ensure with respect to performance.

+

API

+

To register the callback, use +register_add_extra_fields_to_unsigned_client_event_callbacks on the +ModuleApi.

+

The callback should be of the form

+
async def add_field_to_unsigned(
+    event: EventBase,
+) -> JsonDict:
+
+

where the extra fields to add to the event's unsigned section is returned. +(Modules must not attempt to modify the event directly).

+

This cannot be used to alter the "core" fields in the unsigned section emitted +by Synapse itself.

+

If multiple such callbacks try to add the same field to an event's unsigned +section, the last-registered callback wins.

+ +
+ + +
+
+ + + +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/develop/modules/background_update_controller_callbacks.html b/develop/modules/background_update_controller_callbacks.html index 4b30f6bc9c..62851e877b 100644 --- a/develop/modules/background_update_controller_callbacks.html +++ b/develop/modules/background_update_controller_callbacks.html @@ -76,7 +76,7 @@ diff --git a/develop/modules/index.html b/develop/modules/index.html index af253fedf7..d56942176c 100644 --- a/develop/modules/index.html +++ b/develop/modules/index.html @@ -76,7 +76,7 @@ diff --git a/develop/modules/password_auth_provider_callbacks.html b/develop/modules/password_auth_provider_callbacks.html index bf3acec439..941dc90d12 100644 --- a/develop/modules/password_auth_provider_callbacks.html +++ b/develop/modules/password_auth_provider_callbacks.html @@ -76,7 +76,7 @@ diff --git a/develop/modules/porting_legacy_module.html b/develop/modules/porting_legacy_module.html index d803d76acc..b19e5c6612 100644 --- a/develop/modules/porting_legacy_module.html +++ b/develop/modules/porting_legacy_module.html @@ -76,7 +76,7 @@ @@ -168,7 +168,7 @@ for more info).