Export (0) Print
Expand All

Lync Extensibility Classes

[This is preliminary documentation and is subject to change.]

Use the Microsoft Lync 2013 Preview SDK classes to start and automate the Microsoft Lync 2013 Preview UI that is integrated in a third-party application. Use Microsoft Lync Controls to integrate specific features such as presence, contact cards, or search in an application.

Classes and members that relate to extensibility appear in the following sections. For more information about class members, see Lync 2010 API Class Library.

Use Microsoft Lync 2013 Preview SDK UI Automation to create conversations and to dock the conversation window in a third-party application. Use the Automation class to start or join conversations and take advantage of the features built into Lync 2013 Preview. The Automation class is found in the Lync.Model.Extensibility namespace and is obtained from the static LyncClient class by using a call into the GetAutomation method.

The Automation class provides basic automation functionality for applications and it is designed to take advantage of the features appearing in Lync 2013 Preview. After adding a minimal amount of code, the application can then start a conversation, share a desktop application, or join a conference. You can dock a conversation window that is created and maintained by Lync 2013 Preview within your application.

UI Automation starts the Lync 2013 Preview conversation window. You can resize or move the conversation window on the local computer screen. The Automation class includes the following methods.

Method

Description

GetConversationWindow

Returns the conversation window.

LaunchAddContactWizard

Adds a person or group to a contact list.

BeginStartConversation

Starts a conversation or joins a conference.

EndStartConversation

Completes the asynchronous start of a conversation.

With the ConversationWindow class, you specify the docking behavior, size, and location of a window opened by Lync 2013 Preview. The ConversationWindow class includes the following methods and properties.

Method

Description

BeginOpenExtensibilityWindow

Begins to asynchronously start the URL in the Microsoft Lync 2013 Preview Conversation Window Extension (CWE).

Close

Closes the window.

Dock

Docks the window to the specified parent.

EndOpenExtensibilityWindow

Completes the asynchronous start of the CWE.

FlashExtensibilityWindow

Flashes the frame of the CWE to indicate attention is needed.

Move

Moves and resizes the window to the specified coordinates and dimensions.

MoveAndResize

Moves the window to the specified coordinates.

Undock

Undocks the window from any parent.

Property

Description

Conversation

Gets the underlying conversation instance.

Height

Gets the height of the conversation window.

IsDocked

Returns a Boolean value that indicates whether the window is docked.

ConversationWindow.Left

Gets the coordinate of the left edge of the conversation window, in pixels.

ConversationWindow.Top

Gets the coordinate of the top edge of the conversation window, in pixels.

ConversationWindow.Width

Gets the width of the conversation window, in pixels.

Use the LyncClient.GetAutomation method of the Microsoft.Lync.Model.LyncClient class to return a Microsoft.Lync.Model.Extensibility.Automation object. For more information, see CommunicatorClient Class.

Community Additions

Show:
© 2014 Microsoft