LyncClient Class

Definition

Implements the client class which represents the main entry point for the API. Represents the Lync client and provides access to conversations and contacts via their respective manager classes.

public ref class LyncClient : Microsoft::Lync::Model::Client
public class LyncClient : Microsoft.Lync.Model.Client
type LyncClient = class
    inherit Client
Public Class LyncClient
Inherits Client
Inheritance

Properties

Capabilities

Determine whether ours is the preferred client for a capability.

ContactManager

Gets the contact group manager.

(Inherited from Client)
ConversationManager

Gets the conversation manager.

(Inherited from Client)
DelegatorClients

Gets an array of IDelegatorClient objects.

DeviceManager

Gets the device manager.

InnerObject (Inherited from UCWBase)
InSuppressedMode

Returns true when in Full UI Suppression mode.

RoomManager

Gets the group chat room manager.

(Inherited from Client)
Self

Gets the self Contact object representing the signed in user.

(Inherited from Client)
Settings

Gets the settings object.

(Inherited from Client)
SignInConfiguration

Gets the configuration manager.

State

Gets the current platform state.

(Inherited from Client)
Uri

Gets the URI of the client.

(Inherited from Client)
Utilities

Returns an instance of the Utilities class.

Methods

BeginInitialize(AsyncCallback, Object)

Initializes LyncClient when the Lync is in Suppressed Mode. You do not call this method when Lync is not suppressed.

BeginShutdown(AsyncCallback, Object)

Starts the collaboration platform shutdown process.

BeginSignIn(String, String, String, AsyncCallback, Object)

Starts the uc Client sign in process with a specific availability.

BeginSignOut(AsyncCallback, Object)

Starts the uc Client sign out process.

CreateApplicationRegistration(String, String)

Construct an application registration object used to register a Silverlight conversation window extension application.

EndInitialize(IAsyncResult)

Ends the Initialize operation and unblocks program execution on the calling thread.

EndShutdown(IAsyncResult)

Starts the collaboration platform shutdown process.

EndSignIn(IAsyncResult)

Starts the uc Client sign in process with a specific availability.

EndSignOut(IAsyncResult)

Starts the uc Client sign out process.

Finalize()
GetAutomation()

Creates an instance of Automation and returns.

GetClient()

Events

CapabilitiesChanged

Raised when the preferred capabilities changed

ClientDisconnected

Raised when Lync connection is broken.

CredentialRequested

Raised when a user credential is requested by a server such as the Lync server.

DelegatorClientAdded

Raised when a new delegate endpoint is created.

DelegatorClientRemoved

Raised when an existing delegate endpoint is released.

SignInDelayed

Raised when there is a delay in the SignIn/auto-recover process

StateChanged

Occurs when the Client state changes.

(Inherited from Client)

Applies to