Interface Logger1

Interface Index (Compact) | Summary | Description | Methods | Signals | Types

Methods

GetFavouriteContacts () → a(oas): Favourite_Contacts
AddFavouriteContact (o: Account, s: Identifier) → nothing
RemoveFavouriteContact (o: Account, s: Identifier) → nothing
Clear () → nothing
ClearAccount (o: Account) → nothing
ClearEntity (o: Account, s: Identifier, i: Type) → nothing

Signals

FavouriteContactsChanged (o: Account, as: Added, as: Removed)

Types

Favorites Struct (oas)
Added in 0.3. (as a draft)

Description

An interface for requesting information from the Telepathy Logger service.

Methods

(Permalink)

GetFavouriteContacts () → a(oas): Favourite_Contacts

Returns

  • Favourite_Contacts — a(oas) (Favorites_List)
    • The favourite contacts, as an array of TpAccounts and their contact identifiers.
Returns the favourite contacts.
(Permalink)

AddFavouriteContact (o: Account, s: Identifier) → nothing

Parameters

  • Account — o
    • The object path for the TpAccount to which the contact belongs
  • Identifier — s
    • The favourite contact's identifier
Add a contact's designation as a favourite.
(Permalink)

RemoveFavouriteContact (o: Account, s: Identifier) → nothing

Parameters

  • Account — o
    • The object path for the TpAccount to which the contact belongs
  • Identifier — s
    • The favourite contact's identifier
Remove a contact's designation as a favourite.
(Permalink)

Clear () → nothing

Clear all the logs. This will not erase the favourite contacts.
(Permalink)

ClearAccount (o: Account) → nothing

Parameters

  • Account — o
    • The object path for the TpAccount in which logs will be cleared.
Clear all logs stored for specified account.
(Permalink)

ClearEntity (o: Account, s: Identifier, i: Type) → nothing

Parameters

  • Account — o
    • The object path for the TpAccount in which logs will be cleared.
  • Identifier — s
    • The entity identifier.
  • Type — i
    • The entity type, should be one of TP_ENTITY_TYPE_CONTACT (1) or TP_ENTITY_TYPE_ROOM (2).
Clear all logs stored for discussions with entity in account.

Signals

(Permalink)

FavouriteContactsChanged (o: Account, as: Added, as: Removed)

Parameters

  • Account — o
    • An account associated with the contact.
  • Added — as
    • List of contact identifiers of contacts which are now favourites.
  • Removed — as
    • List of contact identifiers of contacts which are no longer favourites.
The set of favourite contacts has changed.

Types

Struct (Permalink)

Favorites — (oas)

A set of favorite contacts on a specific account.
  • Account — o
    • The account path
  • Identifiers — as
    • The identifiers of the favorite contacts.