Skip to content

Privacy settings

PrivacySettings

PrivacySettings(dct=None)

__getitem__

__getitem__(user_entity_tuple: tuple[int, int]) -> Optional[bool]

Returns the user's privacy setting for a given entity.

Parameters:

Name Type Description Default
user_entity_tuple tuple[int, int]

(user_id, entity_id)

required

Returns:

Type Description
Optional[bool]

True (private), False (public) or None (undefined)

__setitem__

__setitem__(user_entity_tuple: tuple[int, int], is_private: Optional[bool])

Store the user's privacy setting for a given entity.

Parameters:

Name Type Description Default
user_entity_tuple tuple[int, int]

(user_id, entity_id)

required
is_private Optional[bool]

True (private), False (public) or None (undefined)

required

entities

entities(user: Optional[int] = None) -> set[int]

users

users(entity: Optional[int] = None) -> set[int]