Edit

Share via

PresenceIndicator control

  • Article

Core concepts

Learn about the properties of the Microsoft Lync 2013PresenceIndicator control.

Applies to: Lync 2013 | Lync Server 2013

In this article
Control overview
Quick connect menu
Members
Code example
Additional resources

Control overview

The PresenceIndicator control displays one of several icons that indicate the presence of a given user. It's a stand-alone control representing a single contact and enables access to the quick connect menu and the contact card for the user. The control also can display a photo for the given user. The following images display different options for the PhotoDisplayMode property. When the Source property is not set or when no photo is available, a stock silhouette image appears in the UI as shown.

PresenceIndicator Control

PresenceIndicator Control

Quick connect menu

The control reacts to two user actions: hover and click. When a user hovers over the icon, after about one second the quick connect menu appears. The quick connect menu displays the contact’s presence, starts IM, email, or audio calls and can be expanded to show detailed contact information. The quick connect menu disappears if it's not used. The user can keep the quick connect menu open by pinning it.

Members

Notable PresenceIndicator control public properties and events relating to unified communications appear in the following table. For information about other properties and events, see Lync 2013 class libraries reference.

Property or event

Description

Source property

Gets or sets the contact to display. Valid types include the Contact object, DistributionGroup object, and String.

  • If the value is a string that does not contain the sip: or tel: prefix, the control performs a search, using the string specified as a search criteria, and loads the first contact in the result set matching the specified string. This behavior is not deterministic and yields the slowest performance.

  • If the value is a SIP URI string qualified by the sip: or tel: prefix, the contact is loaded using an exact match of the specified URI. This behavior is deterministic and yields better performance.

  • If the value is a Contact or DistributionGroup object, it's used without changes. This behavior is deterministic and yields the best performance.

ActivityStatus property

Gets the presence status string for the contact. For example, In a meeting or Away. For groups, this is an empty string.

DisplayName property

Gets the contact’s display name.

ContextualInformation property

Gets or sets a data structure that contains information used to customize the information that accompanies messages. For more information about the use of contextual information, see Contextual Lync conversations.

Model property

Reserved for internal use. When you edit templates, this property may appear in XAML text. To preserve control functionality, it should remain static.

AvailabilityState property

Gets an enumerated value that represents the contact’s availability. The type is a ContactAvailability enumeration. Possible values:

  • Invalid

  • None

  • Free

  • FreeIdle

  • Busy

  • BusyIdle

  • DoNotDisturb

  • TemporarilyAway

  • Away

  • Offline

HoverAction property

Gets or sets an enumeration value that determines the contact card display mode when the cursor hovers over the presence icon. The default value is ShowContactBrief.

SingleClickAction property

Gets or sets an enumeration value that determines the contact card display mode after the presence icon is clicked. The default value is ShowContactDetails.

PhotoDisplayMode property

Gets or sets an enumeration value that determines the presence photo display mode. The default value is Hidden.

Code example

The following sample code is for Microsoft Silverlight and Microsoft Windows Presentation Foundation (WPF).

<StackPanel>
  <controls:PresenceIndicator Source="sip:mary@contoso.com"/>
</StackPanel>

See also