Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

Object model expansion

Lync 2013

What's new topic

The Microsoft Lync 2013 API includes new types to enable the features described in What's new in Lync 2013 SDK.

Last modified: April 05, 2013

Applies to: Lync 2013 | Lync Server 2013

The following sections list the API types that are new to Microsoft Lync 2013 SDK and support the new features.

Persistent Chat API

The following table lists the new API types that support Persistent Chat. For more information about Persistent Chat in the Lync 2013 API, see Get started with Persistent Chat.

Persistent Chat types

Type

Description

FollowedRoomsChangedEventArgs

The state of the event raised when the membership of collection of user-followed chat rooms has changed.

JoinRoomFailException

Encapsulates the state of the exception raised when a user fails to join a chat room.

JoinRoomUnauthorizedException

Encapsulates the state of the exception raised when a user attempts to join a chat room that he or she is not authorized to join.

Room

Encapsulates a Persistent Chat room.

RoomJoinState

Enumerates the Persistent Chat room joining operation states.

RoomJoinStateChangedEventArgs

Encapsulates the state of the RoomJoinStateChanged event.

RoomManager

Persistent Chat room manager that provides room query functionality.

RoomManagerState

Enumerates the room manager state.

RoomManagerStateChangedEventArgs

Exposes the new state of a room manager.

RoomMessage

Defines a room message sent to a Persistent Chat room.

RoomMessageDictionary

A key/value pairing of a message format enumerator and actual message text.

RoomMessageEventArgs

Encapsulates the state of the event raised when a local user sends a message to a Persistent Chat room.

RoomMessagesEventArgs

Encapsulates the state of the MessagesReceived event and contains a collection of the messages sent to a room.

RoomMessageFilteringAction

Enumerates the action taken by a chat room add-in for a room message.

RoomMessageFormat

Enumerates the possible format types of a room message.

RoomMessageType

Enumerates the possible types of a room message.

RoomParticipantsEventArgs

Encapsulates the state of the ParticpiantsAdded and ParticipantsRemoved events and contains a collection of the room participants added or removed.

RoomProperty

Enumerates the room properties.

RoomPropertyChangedEventArgs

Encapsulates the event data of the Room.PropertyChanged event and provides the new value of the changed property.

RoomPropertyDictionary

A dictionary that contains the properties of a Persistent Chat room.

RoomSearchModeType

Enumerates the possible room search mode types.

RoomType

Enumerates the room type.

RoomUser

Defines a user in a Persistent Chat room.

RoomUserChangedEventArgs

Encapsulates the state of the event raised when the ability of a group chat room user to send messages changes.

UnreadMessageCountChangedEventArgs

Encapsulates the state of the event raised when the count of unread messages in a room changes.

Resource sharing API

The following table lists the new API types that support resource sharing. For more information about resource sharing in the Lync 2013 API, see Get started with desktop, application, and display sharing.

Resource sharing types

Type

Description

ApplicationSharingModality

Represents the application sharing modality of a conversation modality collection.

CanShareDetail

Enumerates the detail of why sharing a particular resource is allowed or not allowed.

ControllerChangedEventArgs

Represents the event data of a ControllerChanged event. A controller is a user who takes control of a shared resource.

ControlRequestReceivedEventArgs

Represents the event data of a ControlRequestReceivedEvent event.

SharingResource

Encapsulates a shareable resource such as a desktop, application, or display.

SharingResourceList

Encapsulates a collection of shareable resources.

SharingResourceType

Enumerates the application sharing resource type.

Meeting content API

The following table lists the new API types that support meeting content management. For more information about meeting content sharing in the Lync 2013 API, see Get started with content sharing.

Meeting content types

Type

Description

ActiveContentChangedEventArgs

Represents the event data of a ActiveContentChanged event.

ActivePresenterChangedEventArgs

Represents the event data of a ActivePresenterChangedEvent event.

ContentCollectionChangedEventArgs

Represents the event data of a ContentCollectionChanged event.

ContentSharingModality

Creates and manages a collection of shareable content items.

ParticipationState

Enumerates the application sharing participation states.

ParticipationStateChangedEventArgs

Represents the event data of a ParticipationStateChangedEvent event.

PowerPointContent

Represents a PowerPoint slide deck that is shared on the meeting content stage.

ShareableContent

The ShareableContent class is the common class for all types of content

ShareableContentAction

Enumerates supported content actions.

ShareableContentActionAvailabilityChangedEventArgs

Represents the event data of a ShareableContentActionAvailabilityChangedEvent event.

ShareableContentCollection

Maintains a collection of all shareable content objects.

ShareableContentProperty

Enumerates the content properties.

ShareableContentPropertyChangedEventArgs

Represents the event data of a ShareableContentPropertyChangedEvent event.

ShareableContentState

Enumerates the states of a ShareableContent object.

ShareableContentStateChangedEventArgs

Represents the event data of a ShareableContentStateChangedEvent.

ShareableContentType

Enumerates supported content types.

Other new types

The following table lists the new API types that enhance existing features.

Type

Description

AlertLevel

Presence-based alert policy.

AlertLevelChangedEventArgs

Encapsulates the new state of an AlertLevel instance.

AlertModeTypes

Enumerates the modes of alert events.

AlertPrivacyType

A privacy level for the level of alert.

PresenceCapability

Encapsulates a presence capability as published by a contact.

PresenceCapabilityType

Enumerates the published communications capabilities of a contact.

ContextType

Enumerates the types of context data that can be sent in a conversation.

ConferenceAccessType

Enumerates the types of user access that can be assigned to a conference.

ExchangeECPUrlChangedEventArgs

Encapsulates the new state of the Exchange ECP URL, which is raised when the Exchange ECP URL changes.

NotificationTypes

Enumerates the notification types that are related to the level of alert.

NotificationUrgencyType

Enumerates the urgency levels for the notification.

Changed types

The types in the following table have been changed by adding additional members.

Type

Description of change

GetHostingRoom

When called from a Persistent Chat room add-in, gets the Room object of the hosting chat room.

ConferenceAccessType

Enumerates the conference admission types.

ConversationWindow

New properties and events: Properties, State, InformationChanged, and StateChanged.

CredentialRequestedType

New enumerators: LyncAutodiscover and SipAuthBroker.

ContactInformationType

New enumerator to support contact capability details. CapabilityDetails

ModalityAction

New enumerators to support resource and meeting content sharing.

ModalityTypes

New enumerators to support resource and meeting content sharing.

Self

New members: GetAlertLevelForNotification, AlertLevelChanged.

Utilities

New property: ExchangeECPUrl. New Event: Utilities.ExchangeECPUrlChanged.

Show:
© 2015 Microsoft