Interface org.freedesktop.Telepathy.Connection.Interface.ContactBlocking.DRAFT

Interface Index (Compact) | Summary | Description | Methods | Signals | Contact Attributes

Methods

BlockContacts (au: Contact) → nothing
UnblockContacts (au: Contact) → nothing
RequestBlockedContacts () → au: Contacts

Signals

BlockedContactsChanged (au: BlockedContacts, au: UnblockedContacts)

Contact Attributes

org.freedesktop.Telepathy.Connection.Interface.ContactBlocking.DRAFT/blocked b
Objects implementing this interface must also implement:

Description

An interface for connections where contacts can be blocked from communicating with this user and receiving this user's presence.

When this interface becomes stable, it will replace the ContactList channel with TargetHandleType Handle_Type_List and TargetID 'deny'.

Methods

(Permalink)

BlockContacts (au: Contact) → nothing

Parameters

Direct the server to block some contacts. The precise effect is protocol-dependent, but SHOULD include ignoring all current and subsequent communications from the given contacts, avoiding sending presence to them in future, and if they were already receiving the local user's presence, behaving as if the local user went offline.

FIXME: do we need to allow this on protocols where it won't persist, or where we can't edit the block lists?

Possible Errors

  • Disconnected
    • The connection is not currently connected and cannot be used. This error may also be raised when operations are performed on a Connection for which StatusChanged has signalled status Disconnected for reason None.
    The second usage corresponds to None in the Connection_Status_Reason enum; if a better reason is available, the corresponding error should be used instead.
  • Invalid Handle
    • The handle specified is unknown on this channel or connection.
  • Network Error
    • Raised when there is an error reading from or writing to the network.
(Permalink)

UnblockContacts (au: Contact) → nothing

Parameters

Reverse the effects of a previous call to BlockContacts.

Possible Errors

  • Disconnected
    • The connection is not currently connected and cannot be used. This error may also be raised when operations are performed on a Connection for which StatusChanged has signalled status Disconnected for reason None.
    The second usage corresponds to None in the Connection_Status_Reason enum; if a better reason is available, the corresponding error should be used instead.
  • Invalid Handle
    • The handle specified is unknown on this channel or connection.
  • Network Error
    • Raised when there is an error reading from or writing to the network.
(Permalink)

RequestBlockedContacts () → au: Contacts

Returns

List the contacts that are blocked.

Clients SHOULD allow a relatively long timeout for calls to this method, since on some protocols contact blocking is part of the contact list, which can take a significant time to retrieve.

Possible Errors

  • Disconnected
    • The connection is not currently connected and cannot be used. This error may also be raised when operations are performed on a Connection for which StatusChanged has signalled status Disconnected for reason None.
    The second usage corresponds to None in the Connection_Status_Reason enum; if a better reason is available, the corresponding error should be used instead.
  • Invalid Handle
    • The handle specified is unknown on this channel or connection.
  • Network Error
    • Raised when there is an error reading from or writing to the network.

Signals

(Permalink)

BlockedContactsChanged (au: BlockedContacts, au: UnblockedContacts)

Parameters

Emitted when the list of blocked contacts is first retrieved (before returning from any pending calls to RequestBlockedContacts), and whenever the list of blocked contacts subsequently changes.

Contact Attributes

Attributes that a contact can have, accessed with the org.freedesktop.Telepathy.Connection.Interface.Contacts interface.
(Permalink)

org.freedesktop.Telepathy.Connection.Interface.ContactBlocking.DRAFT/blocked — b

True if the contact would be in the result of RequestBlockedContacts; False or omitted if the contact is not blocked, or if it is unknown whether the contact is blocked.