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 The result may be True (for private), False (for public) or None (if undefined).

Parameters:

Name Type Description Default
user_entity_tuple tuple[int, int]
required

Returns:

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

__setitem__

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

Returns the user's privacy setting for a given entity The result may be True (for private), False (for public) or None (if undefined).

Parameters:

Name Type Description Default
user_entity_tuple tuple[int, int]
required
is_private Optional[bool]
required

entities

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

users

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