Edit

Share via

Friends and Family container

  • Article

Applies to: Lync 2013 | Lync Server 2013

The Friends and Family Container has a container ID value of 400. The default access control list does not contain an entry. When a user changes the privacy relationship with a contact to Friends and Family by using the Change Privacy Relationship menu in Microsoft Lync 2013, the affected contact is added as a member of this container.

The following category instances are published to this container.

Category instances published by Lync Server 2013

Category name

Instance ID

Description

contactCard category instance value element

0

Contains the local user’s identity that consists of the display name and email address as provisioned from the Active Directory domain. The following is an example of this category instance.

<contactCard xmlns="http://schemas.microsoft.com/2006/09/sip/contactcard">
  <identity>
    <name>
      <displayName>John Barr</displayName>
    </name>
    <email>john.barr@exchange.contoso.com</email>
  </identity>
</contactCard>

legacyInterop category instance value element

1

Contains the availability number of the local user’s current state[@type='aggregateState'] element. It makes the local user’s presence status available to the container members that use legacy clients. The following is an example of this category instance.

<legacyInterop availability="3500" xmlns="http://schemas.microsoft.com/2006/09/sip/categories" />

Category instances published by aggregation script

Category name

Instance ID

Description

state[@type='aggregateState'] element

1

Contains the local user’s current availability number, time zone, and device type. The following is an example of this category instance.

<state xsi:type="aggregateState" 
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
       xmlns="http://schemas.microsoft.com/2006/09/sip/state">
  <availability>3500</availability>
  <delimiter xmlns="http://schemas.microsoft.com/2006/09/sip/commontypes" />
  <timeZoneBias>420</timeZoneBias>
  <timeZoneName>Pacific Daylight Time</timeZoneName>
  <timeZoneAbbreviation>Pacific Daylight Time</timeZoneAbbreviation>
  <device>computer</device>
  <end xmlns="http://schemas.microsoft.com/2006/09/sip/commontypes" />
</state>

Note

This publication is different from the corresponding item in the External Contacts Container (Container 100).

services category instance value element

0

Contains the endpoint-independent presence capabilities of the local user. This is shown in the following example.

<services xmlns="http://schemas.microsoft.com/2006/09/sip/service">
  <service uri="sip:kdeding@microsoft.com">
    <capabilities>
      <text render="true" capture="true" deviceAvailability="3500" />
      <gifInk render="true" capture="false" deviceAvailability="3500" />
      <isfInk render="true" capture="false" deviceAvailability="3500" />
      <applicationSharing render="true" capture="true" deviceAvailability="3500" />
      <voice render="true" capture="true" deviceAvailability="3500" />
      <video render="true" capture="true" deviceAvailability="3500" />
      <contentWhiteboard render="true" capture="true" deviceAvailability="3500" />
      <contentPoll render="true" capture="true" deviceAvailability="3500" />
      <contentPowerPoint render="true" capture="true" deviceAvailability="3500" />
      <contentNativeFile render="true" capture="true" deviceAvailability="3500" />
    </capabilities>
  </service>
</services>

Category instances published by Lync 2013

Category name

Instance ID

Description

contactCard category instance value element

1

Contains the home phone number as part of the contact information of the local user. This is shown in the following example.

<contactCard xmlns="http://schemas.microsoft.com/2006/09/sip/contactcard" 
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
             xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <phone type="home">
    <uri>tel:+12064445555</uri>
  </phone>
</contactCard>

This category instance is meant to contain the local user’s contact information as constructed from the user-configurable options, such as the local user’s home phone number.

Note

By default, Lync 2013 only publishes user-configured home phone numbers to the Friends and Family container.

contactCard category instance value element

3

Contains the local user’s company description and job title, which are obtained from the underlying Microsoft Lync Server 2013 Address Book Server. This is shown in the following example.

<contactCard xmlns="http://schemas.microsoft.com/2006/09/sip/contactcard"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <company>Contoso</company>
  <title>Senior Employee</title>
</contactCard>

contactCard category instance value element

4

Contains the server-provisioned voice mail URL of the local user when the user has unified communications (UC) enabled. This is shown in the following example.

<contactCard xmlns="http://schemas.microsoft.com/2006/09/sip/contactcard" isUCEnabled="true">
  <url type="voicemail">sip:johnd@contos.com;opaque=app:voicemail;local-resource-path=voicememo</url>
</contactCard>

contactCard category instance value element

6

Contains the local user’s job title and display photo. This displays the local user’s photo for members of this container. This is shown in the following example.

<contactCard xmlns="http://schemas.microsoft.com/2006/09/sip/contactcard">
  <title>SENIOR EMPLOYEE</title>
  <delimiter xmlns:auto-ns1="http://schemas.microsoft.com/2006/09/sip/contactcard" 
             xmlns="http://schemas.microsoft.com/2006/09/sip/commontypes">
  </delimiter>
  <delimiter xmlns:auto-ns1="http://schemas.microsoft.com/2006/09/sip/contactcard" 
             xmlns="http://schemas.microsoft.com/2006/09/sip/commontypes">
  </delimiter>
  <displayADPhoto>true</displayADPhoto>
  <photo type="enterprise" updated="2010-05-24T21:08:59Z">
    <uri></uri>
    <hash>10b394d3bdc9b3f999e44efb5c269dda</hash>
  </photo>
</contactCard>

calendarData category instance value element

0

Contains the local user’s working-hours information that is obtained from the user’s Microsoft Exchange account.

<calendarData 
      xmlns="http://schemas.microsoft.com/2006/09/sip/calendarData" 
      mailboxID="johnd@exchange.contoso.com">
  <WorkingHours 
      xmlns:auto-ns1="http://schemas.microsoft.com/2006/09/sip/calendarData" 
      xmlns="http://schemas.microsoft.com/exchange/services/2006/types">
    <TimeZone>
      <Bias>480</Bias>
      <StandardTime>
        <Bias>0</Bias>
        <Time>02:00:00</Time>
        <DayOrder>1</DayOrder>
        <Month>11</Month>
        <DayOfWeek>Sunday</DayOfWeek>
      </StandardTime>
      <DaylightTime>
        <Bias>-60</Bias>
        <Time>02:00:00</Time>
        <DayOrder>2</DayOrder>
        <Month>3</Month>
        <DayOfWeek>Sunday</DayOfWeek>
      </DaylightTime>
    </TimeZone>
  <WorkingPeriodArray>
    <WorkingPeriod>
      <DayOfWeek>Monday Tuesday Wednesday Thursday Friday</DayOfWeek>
      <StartTimeInMinutes>480</StartTimeInMinutes>
      <EndTimeInMinutes>1020</EndTimeInMinutes>
    </WorkingPeriod>
  </WorkingPeriodArray>
  </WorkingHours>
</calendarData>

calendarData category instance value element

A hash dependent on the local user’s email address

Contains the local user’s free-busy information, as shown in the following example.

<calendarData xmlns="http://schemas.microsoft.com/2006/09/sip/calendarData" mailboxID="johnd@exchange.contoso.com">
  <freeBusy startTime="2010-06-21T07:00:00Z" granularity="PT15M" encodingVersion="1">AAAAAAAAAAAAAAAAVVUAAAAAAAAAAAAAAAAAAAAAAAAAAAAAVQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAVQAAAAAAAAAAAAAAAAAAAAAAAABUUVVVBQAAAAAAAAAA</freeBusy>
</calendarData>

Note

The local user’s free-busy information is visible to the Colleagues, Workgroup, and Friends and Family container members, while it's not visible to the External Contacts container members.

dndState category instance value element

0

Contains an empty value when the local user is not in the Do not disturb availability mode, and contains an availability number of 9500 when the user is in the Do not disturb mode. This is shown in the following example.

<state xmlns="http://schemas.microsoft.com/2006/09/sip/state" 
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
       xsi:type="userState" manual="true" />

note category instance value element

0

Contains a personal note set by the local user. This is shown in the following example.

<note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
      xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
      xmlns="http://schemas.microsoft.com/2006/09/sip/note">
  <body type="personal" uri="">A personal message</body>
</note>

note category instance value element

A hash dependent of the local user’s email address

Published during an OOF period, this instance contains an out-of-facility (OOF) note that the local user sets in Microsoft Outlook as shown in the following example.

<note xmlns="http://schemas.microsoft.com/2006/09/sip/note">
  <body type="OOF" 
        uri="johnd@exchange.contoso.com"
        startTime="2010-06-22T19:00:00Z"
        endTime="2010-06-23T19:00:00Z">A OOF message set in Outlook</body>
</note>

Note

The OOF note is visible to the Colleagues, Workgroup, and Friends and Family container members, while it's not visible to the External Contacts container members.

noteHistory category instance value element

Contains a local user’s previously published personal note, as shown in the following example.

<noteHistory xmlns="http://schemas.microsoft.com/2006/09/sip/note">
  <body type="personal" uri="">Out to lunch</body>
</noteHistory>

Note

noteHistory category instance value element is published to Colleagues, Workgroup, and Friends and Family container members, but not to the External Contacts container. By default, there can be up to three noteHistory category instance value element category instances and they correspond to the three most recent note category instance value element instances that are published before the current one.

routing category instance value element

various

One or more routing category instance value element category instances that contain the user-configurable routing rules that are used to handle incoming calls from a member of this container. The following is an example of such an instance.

<routing xmlns="http://schemas.microsoft.com/02/2006/sip/routing" 
         name="rtcdefault" version="2" minSupportedClientVersion="4.0.0.0">
  <preamble>
    <flags name="clientflags" value="simultaneous_ring"></flags>
    <wait name="total" seconds="20"></wait>
    <list name="forwardto"></list>
    <wait name="user" seconds="0"></wait>
    <wait name="team1" seconds="0"></wait>
    <wait name="team2" seconds="0"></wait>
    <list name="simultaneous_ring">
      <target uri="sip:+12065551111@contoso.com;user=phone"></target>
    </list>
  </preamble>
</routing>

See also

Concepts

Container semantics defined and conformed by Lync