ContextKit D-Bus interface specification

Version 0.0.1

Copyright (C) 2008 Nokia Corporation

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Interfaces

org.freedesktop.ContextKit.Manager

Methods:

Get ( as: keys ) → a{sv}, as

Get the values of a set of context keys.

Parameters

keys − as
An array of the keys to get.

Returns

values − a{sv} (Value_Set)
A Value_Set mapping the requested keys to their values.
undeterminable_keys − as
An array of keys which we couldn't determine the values for.

GetSubscriber ( ) → o

Get the Subscriber object for making subscriptions.

Returns

subscription_object − o
The object on which to subscribe, unsubscribe keys and listen to key value changes.

Interface has no signals.

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

org.freedesktop.ContextKit.Subscriber

Methods:

Subscribe ( as: keys ) → a{sv}, as

Subscribe to a one or more keys

Parameters

keys − as
An array of the keys to subscribe to.

Returns

values − a{sv} (Value_Set)
A Value_Set mapping the requested keys to their current values.
undeterminable_keys − as
An array of keys which we couldn't determine the values for.

Unsubscribe ( as: keys ) → nothing

A Value_Set mapping the requested keys to their values.

Parameters

keys − as
An array of the keys to unsubscribe from.

Signals:

Changed ( a{sv}: values, as: undeterminable_keys )

Parameters

values − a{sv} (Value_Set)
A Value_Set mapping the changed keys to their values.
undeterminable_keys − as
An array of keys which we can no longer determine the values for.

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

org.maemo.contextkit.Property

Methods:

Subscribe ( ) → av, t

Subscribes to the context property.

Returns

value − av (Maybe_Variant)
The actual value at the of subscription.
timestamp − t
The timestamp of the value.

Unsubscribe ( ) → nothing

Unsubscribes from the property.

Get ( ) → av, t

Returns the actual value from the provider without subscribing to it.

Returns

value − av (Maybe_Variant)
timestamp − t

Signals:

Changed ( av: value, t: timestamp )

Emitted when the value changed and there are at least one subscribed client.

Parameters

value − av (Maybe_Variant)
timestamp − t

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

Generic types

Simple types

Maybe_Variant − av

A list of variants where empty list represents unknown, otherwise it represents the same variant as the contained first variant. This hack is needed because D-Bus doesn't support null values on the wire.

Mapping types

Value_Set − a{ s: Key → v: Value }

A mapping from key names to a variant

Members

Key − s
(undocumented)
Value − v
(undocumented)

Index

Index of interfaces

Index of types