PhoneDialOptions PhoneDialOptions PhoneDialOptions PhoneDialOptions Class

Definition

Represents options for dialing a call.

public : sealed class PhoneDialOptions : IPhoneDialOptionspublic sealed class PhoneDialOptions : IPhoneDialOptionsPublic NotInheritable Class PhoneDialOptions Implements IPhoneDialOptions// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0)
API contract
Windows.ApplicationModel.Calls.CallsPhoneContract (introduced v1)

Remarks

If you are supplying an IContact as the Contact, then you need to make sure it is a component contact and not an aggregate contact. This will make sure that the correct contact is reached when you attempt to place a call using these PhoneDialOptions. Otherwise, the additional information in the contact will be lost and a lookup will be performed using only the number. This might result in the incorrect contact being selected if multiple contacts share the same number but have different metadata.

Constructors

PhoneDialOptions() PhoneDialOptions() PhoneDialOptions() PhoneDialOptions()

Creates a new instance of the class

public : PhoneDialOptions()public PhoneDialOptions()Public Sub New()// You can use this method in JavaScript.

Properties

AudioEndpoint AudioEndpoint AudioEndpoint AudioEndpoint

Gets or sets the audio endpoint requested for a dial.

public : PhoneAudioRoutingEndpoint AudioEndpoint { get; set; }public PhoneAudioRoutingEndpoint AudioEndpoint { get; set; }Public ReadWrite Property AudioEndpoint As PhoneAudioRoutingEndpoint// You can use this property in JavaScript.

Remarks

The audio endpoint specified by the application is provided as a hint to the system. The system might ignore this information if, for example, the current audio routing policies don't support the specified endpoint.

Contact Contact Contact Contact

Gets or sets the address book contact associated with a dial request.

public : Contact Contact { get; set; }public Contact Contact { get; set; }Public ReadWrite Property Contact As Contact// You can use this property in JavaScript.
Value
Contact Contact Contact Contact

The address book contact associated with a dial request.

Remarks

If you are supplying an IContact as the Contact, then you need to make sure it is a component contact and not an aggregate contact. This will make sure that the correct contact is reached when you attempt to place a call using these PhoneDialOptions. Otherwise, the additional information in the contact will be lost and a lookup will be performed using only the number. This might result in the incorrect contact being selected if multiple contacts share the same number but have different metadata.

ContactPhone ContactPhone ContactPhone ContactPhone

Gets or sets the phone number property of the address book contact that is associated with the dial request.

public : ContactPhone ContactPhone { get; set; }public ContactPhone ContactPhone { get; set; }Public ReadWrite Property ContactPhone As ContactPhone// You can use this property in JavaScript.
Value
ContactPhone ContactPhone ContactPhone ContactPhone

The phone number property of the address book contact associated with the dial request.

DisplayName DisplayName DisplayName DisplayName

Gets or sets the name of the party being dialed. This value is displayed if the number being dialed does not have a party name with a matching number in the user's address book.

public : PlatForm::String DisplayName { get; set; }public string DisplayName { get; set; }Public ReadWrite Property DisplayName As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The name of the party being dialed.

Media Media Media Media

Gets or Sets the type or types of media requested for a dial.

public : PhoneCallMedia Media { get; set; }public PhoneCallMedia Media { get; set; }Public ReadWrite Property Media As PhoneCallMedia// You can use this property in JavaScript.
Value
PhoneCallMedia PhoneCallMedia PhoneCallMedia PhoneCallMedia

The type or types of media requested for a dial.

Number Number Number Number

Gets or sets the phone number to dial.

public : PlatForm::String Number { get; set; }public string Number { get; set; }Public ReadWrite Property Number As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The phone number to dial.

Remarks

If no number is specified in this property, the system will attempt to get the number automatically from the associated ContactPhone instance. Otherwise, this Number will take precedence.