diff options
| author | Erik Johnston <erik@matrix.org> | 2019-01-24 18:08:08 +0000 |
|---|---|---|
| committer | Erik Johnston <erik@matrix.org> | 2019-01-24 18:08:08 +0000 |
| commit | 5ee1f997a8e7177077e2c5f0750e28725a452791 (patch) | |
| tree | 4cd8f14b84e9c33f5808128ee9955bb4cb99d707 /synapse/federation | |
| parent | Remove unecessary setting of outlier bit (diff) | |
| download | synapse-5ee1f997a8e7177077e2c5f0750e28725a452791.tar.xz | |
Update make_membership_event docs
Diffstat (limited to 'synapse/federation')
| -rw-r--r-- | synapse/federation/federation_client.py | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/synapse/federation/federation_client.py b/synapse/federation/federation_client.py index f4adcb556d..df7d18700c 100644 --- a/synapse/federation/federation_client.py +++ b/synapse/federation/federation_client.py @@ -524,6 +524,8 @@ class FederationClient(FederationBase): Does so by asking one of the already participating servers to create an event with proper context. + Returns a fully signed and hashed event. + Note that this does not append any events to any graphs. Args: @@ -538,8 +540,9 @@ class FederationClient(FederationBase): params (dict[str, str|Iterable[str]]): Query parameters to include in the request. Return: - Deferred: resolves to a tuple of (origin (str), event (object)) - where origin is the remote homeserver which generated the event. + Deferred[tuple[str, FrozenEvent]]: resolves to a tuple of `origin` + and event where origin is the remote homeserver which generated + the event. Fails with a ``SynapseError`` if the chosen remote server returns a 300/400 code. |