spell out that include_deleted_devices requires include_all_devices

pull/3520/head
Matthew Hodgson 2018-07-19 10:59:02 +01:00
parent 37c4fba0ac
commit c0685f67c0
1 changed files with 5 additions and 1 deletions

View File

@ -74,7 +74,8 @@ class EndToEndKeyStore(SQLBaseStore):
include_all_devices (bool): whether to include entries for devices
that don't have device keys
include_deleted_devices (bool): whether to include null entries for
devices which no longer exist (but were in the query_list)
devices which no longer exist (but were in the query_list).
This option only takes effect if include_all_devices is true.
Returns:
Dict mapping from user-id to dict mapping from device_id to
dict containing "key_json", "device_display_name".
@ -100,6 +101,9 @@ class EndToEndKeyStore(SQLBaseStore):
query_clauses = []
query_params = []
if include_all_devices is False:
include_deleted_devices = False
if include_deleted_devices:
deleted_devices = set(query_list)