Interface Channel.Interface.VoicemailRetrieval.DRAFT

Interface Index (Compact) | Summary | Description | Properties

Properties

VoicemailSenderHandle u (Handle) Read only Immutable, Requestable
VoicemailSenderID s Read only Immutable, Requestable
VoicemailTimestamp x (Unix_Timestamp64) Read only Immutable, Requestable
WARNING: This interface is experimental and is likely to cause havoc to your API/ABI if bindings are generated. Do not include this interface in libraries that care about compatibility.

Description

The presence of this interface in a StreamedMedia or Call.DRAFT channel's Interfaces indicates that the call is for voicemail retrieval. Depending on the protocol, properties on this channel may also provide information about the particular voicemail being retrieved.

On some protocols—including most cellular telephony services, voicemail is retrieved by calling one particular number-which plays back all your voicemails in order and might be controllable using DTMF tones. On such protocols, none of the properties on this interface are requestable, and they all take dummy values on channels; this interface is only used as a marker that a channel is for voicemail retrieval.

Other protocols—such as Skype and visual voicemail-enabled cellular services—support retrieving individual voicemails, identified by their sender and timestamp. On those protocols, VoicemailTimestamp and one of VoicemailSenderID or VoicemailSenderHandle must be included in channel requests; the resulting channel plays back that single voicemail.

Voicemail notifications are provided on the MailNotification.DRAFT interface; the channel-request field in a Mail contains a channel request (a Qualified_Property_Value_Map) which should be made to receive either that voicemail, or all voicemails. FIXME: specify this a bit better, and do so on MailNotification, and rename it.

Rationale:

On the Nokia N900, which predates the MailNotification interface, voicemail notifications are implemented as specially-formatted Message_Part[]s on a special Text channel. Cellular voicemail notifications contain the phone number which should be called; Skype voicemail notifications contain the values for the VoicemailSenderID and VoicemailTimestamp properties on a precursor of this interface.

But now we have the MailNotification interface, these fit much better there.

Properties

Accessed using the org.freedesktop.DBus.Properties interface.
(Permalink)

VoicemailSenderHandle — u (Handle)

Read only
This property is immutable which means that it can never change once the channel has been created. Immutable properties SHOULD appear in the channel detail list of NewChannels signals
This property is requestable which means that it is allowed in the properties hash of a channel request such as in the the CreateChannel and EnsureChannel methods on Requests and ChannelDispatcher. The property should also appear in either the Fixed_Properties or Allowed_Properties lists of a RequestableChannelClass advertised by the CM.

On Skype-style protocols, the handle of the voicemail sender; otherwise, 0.

This property should only be requestable on Skype-style protocols.

(Permalink)

VoicemailSenderID — s

Read only
This property is immutable which means that it can never change once the channel has been created. Immutable properties SHOULD appear in the channel detail list of NewChannels signals
This property is requestable which means that it is allowed in the properties hash of a channel request such as in the the CreateChannel and EnsureChannel methods on Requests and ChannelDispatcher. The property should also appear in either the Fixed_Properties or Allowed_Properties lists of a RequestableChannelClass advertised by the CM.

The string received by inspecting the VoicemailSenderHandle property, or "" if that property is 0.

This property should only be requestable on Skype-style protocols; requests SHOULD only include either this property or VoicemailSenderHandle, not both.

(Permalink)

VoicemailTimestamp — x (Unix_Timestamp64)

Read only
This property is immutable which means that it can never change once the channel has been created. Immutable properties SHOULD appear in the channel detail list of NewChannels signals
This property is requestable which means that it is allowed in the properties hash of a channel request such as in the the CreateChannel and EnsureChannel methods on Requests and ChannelDispatcher. The property should also appear in either the Fixed_Properties or Allowed_Properties lists of a RequestableChannelClass advertised by the CM.

On Skype-style protocols, bong bong bong.

The timestamp of the voicemail message being retrieved, or 0 if this channel is not for one particular voicemail.