LyncClient members

  • Article

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.

The LyncClient type exposes the following members.

Constructors

  Name Description
Protected method LyncClient

Top

Properties

  Name Description
Protected property AdviseMap (Inherited from ComObject.)
Public property Capabilities Determine whether ours is the preferred client for a capability.
Public property ContactManager Gets the contact group manager. (Inherited from Client.)
Public property ConversationManager Gets the conversation manager. (Inherited from Client.)
Public property DelegatorClients Gets an array of IDelegatorClient objects.
Public property DeviceManager Gets the device manager.
Public property InSuppressedMode Returns true when in Full UI Suppression mode.
Public propertyStatic member OfficeIntegrationObject
Public property RoomManager Gets the group chat room manager. (Inherited from Client.)
Public property ScriptObject (Inherited from ScriptWrapper.)
Public property Self Gets the self Contact object representing the signed in user. (Inherited from Client.)
Public property Settings Gets the settings object. (Inherited from Client.)
Public property SignInConfiguration Gets the configuration manager.
Public property State Gets the current platform state. (Inherited from Client.)
Public property Uri Gets the URI of the client. (Inherited from Client.)
Public property Utilities Returns an instance of the Utilities class.

Top

Methods

  Name Description
Protected method AttachEvent(Guid) (Inherited from ComObject.)
Protected method AttachEvent(Object, Guid) (Inherited from ComObject.)
Public method BeginInitialize Initializes LyncClient when the Lync is in Suppressed Mode. You do not call this method when Lync is not suppressed.
Public method BeginShutdown Starts the collaboration platform shutdown process.
Public method BeginSignIn Starts the uc Client sign in process with a specific availability.
Public method BeginSignOut Starts the uc Client sign out process.
Public method CreateApplicationRegistration Construct an application registration object used to register a Silverlight conversation window extension application.
Public method CreateArray (Inherited from ComObject.)
Public method CreateArrayFromEnum (Inherited from ComObject.)
Protected method CreateEventDispatcher (Inherited from ComObject.)
Public method CreateObjectParameter (Inherited from UCWBase.)
Public method CreateParameters (Inherited from ComObject.)
Protected method DetachEvent (Inherited from ComObject.)
Public method EndInitialize Ends the Initialize operation and unblocks program execution on the calling thread.
Public method EndShutdown Starts the collaboration platform shutdown process.
Public method EndSignIn Starts the uc Client sign in process with a specific availability.
Public method EndSignOut Starts the uc Client sign out process.
Protected method EnsureEventAdd(IEnumerable<MulticastDelegate>, Guid) (Inherited from ComObject.)
Protected method EnsureEventAdd(MulticastDelegate, Guid) (Inherited from ComObject.)
Protected method EnsureEventAdd(IEnumerable<MulticastDelegate>, Object, Guid) (Inherited from ComObject.)
Protected method EnsureEventRemove(IEnumerable<MulticastDelegate>, Guid) (Inherited from ComObject.)
Protected method EnsureEventRemove(MulticastDelegate, Guid) (Inherited from ComObject.)
Public method Equals(Object) (Inherited from ComObject.)
Public method Equals(ScriptObject) (Inherited from ScriptWrapper.)
Public method Equals(ScriptWrapper) (Inherited from ScriptWrapper.)
Protected method Finalize (Inherited from UCWBase.)
Public methodStatic member GetAutomation Creates an instance of Automation and returns.
Public methodStatic member GetClient
Public method GetEnumerator (Inherited from ComObject.)
Public method GetHashCode (Inherited from ComObject.)
Public methodStatic member GetHostingConversation
Public methodStatic member GetHostingRoom
Public method GetInteropEnumerator (Inherited from ComObject.)
Protected method GetProperty (Inherited from ScriptWrapper.)
Protected method GetPropertyBoolean (Inherited from ScriptWrapper.)
Public method GetPropertyEx (Inherited from ComObject.)
Protected method GetPropertyInt32 (Inherited from ScriptWrapper.)
Protected method GetPropertyScript (Inherited from ScriptWrapper.)
Protected method GetPropertyString (Inherited from ScriptWrapper.)
Public method GetScriptEnumerator (Inherited from ComObject.)
Public method GetType (Inherited from Object.)
Protected method Invoke (Inherited from ScriptWrapper.)
Public method InvokeEx (Inherited from ComObject.)
Protected method InvokeMethod (Inherited from ScriptWrapper.)
Protected method MemberwiseClone (Inherited from Object.)
Public method PersistAddRef (Inherited from UCWBase.)
Public method PersistRemoveRef (Inherited from UCWBase.)
Public method SetPersistence (Inherited from UCWBase.)
Protected method SetProperty (Inherited from ScriptWrapper.)
Public method SetPropertyEx (Inherited from ComObject.)
Public method ToString (Inherited from Object.)

Top

Events

  Name Description
Public event CapabilitiesChanged Raised when the preferred capabilities changed
Public event ClientDisconnected Raised when Lync connection is broken.
Public event CredentialRequested Raised when a user credential is requested by a server such as the Lync server.
Public event DelegatorClientAdded Raised when a new delegate endpoint is created.
Public event DelegatorClientRemoved Raised when an existing delegate endpoint is released.
Public event SignInDelayed Raised when there is a delay in the SignIn/auto-recover process
Public event StateChanged Occurs when the Client state changes. (Inherited from Client.)

Top

See also

Reference

LyncClient class

Microsoft.Lync.Model namespace