United States (English)

Home Library Learn Samples Downloads Support Community Forums

MSDN Library

Servers and Enterprise Development

Lync

Communications Server

Communications Server 2007

Unified Communications Client 1.0 SDK Documentation

Unified Communications Client API Reference

Microsoft.Office.Interop.UccApi

_IUccApplicationSessionParticipantEvents Interface

_IUccAudioMediaChannelEvents Interface

_IUccAudioVideoMediaChannelEvents Interface

_IUccAudioVideoSessionEvents Interface

_IUccAudioVideoSessionParticipantEvents Interface

_IUccCategoryContextEvents Interface

_IUccCategoryInstanceEvents Interface

_IUccConferenceEntityViewCollectionEvents Interface

_IUccConferenceEntityViewEvents Interface

_IUccConferenceManagerSessionEvents Interface

_IUccConferenceMediaChannelCollectionEvents Interface

_IUccConferenceMediaChannelEvents Interface

_IUccConferenceSessionEvents Interface

_IUccConferenceSessionParticipantEndpointEvents Interface

_IUccConferenceSessionParticipantEvents Interface

_IUccContactEvents Interface

_IUccContainerEvents Interface

_IUccContainerMemberEvents Interface

_IUccEndpointEvents Interface

_IUccGroupEvents Interface

_IUccInstantMessagingSessionEvents Interface

_IUccInstantMessagingSessionParticipantEvents Interface

_IUccMediaChannelCollectionEvents Interface

_IUccMediaChannelDevicesEvents Interface

_IUccMediaChannelEvents Interface

_IUccMediaDeviceManagerEvents Interface

_IUccMediaEndpointEvents Interface

_IUccOperationManagerEvents Interface

_IUccPlatformEvents Interface

_IUccPresentityEvents Interface

_IUccPublicationEvent Interface

_IUccPublicationManagerEvents Interface

_IUccServerSignalingSettingsEvents Interface

_IUccSessionCallControlEvents Interface

_IUccSessionDescriptionEvaluator Interface

_IUccSessionEvents Interface

_IUccSessionManagerEvents Interface

_IUccSessionParticipantCollectionEvents Interface

_IUccSessionParticipantEndpointCollectionEvents Interface

_IUccSessionParticipantEvents Interface

_IUccSignalingChannelEvents Interface

_IUccSubscriptionEvents Interface

_IUccUserSearchQueryEvents Interface

IUccApplicationSessionParticipant Interface

IUccArray Interface

IUccAudioMediaChannel Interface

IUccAudioMediaDevice Interface

IUccAudioSignalLevelChangedEvent Interface

IUccAudioVideoMediaChannel Interface

IUccAudioVideoMediaChannelSourceEvent Interface

IUccAudioVideoMediaChannelStreamsEvent Interface

IUccAudioVideoSession Interface

IUccAudioVideoSessionParticipant Interface

IUccCategoryContext Interface

IUccCategoryContextEvent Interface

IUccCategoryInstance Interface

IUccCategoryInstanceEvent Interface

IUccCollection Interface

IUccConferenceEntityView Interface

IUccConferenceEntityViewCollectionEvent Interface

IUccConferenceInformation Interface

IUccConferenceManager Interface

IUccConferenceManagerSession Interface

IUccConferenceMediaChannel Interface

IUccConferenceSession Interface

IUccConferenceSessionParticipant Interface

IUccConferenceSessionParticipantEndpoint Interface

IUccConferenceSessionParticipantEndpointStateChangedEvent Interface

IUccConferenceView Interface

IUccContact Interface

IUccContactCollectionEvent Interface

IUccContainer Interface

IUccContainerMember Interface

IUccContainerMemberCollectionEvent Interface

IUccContainerMembershipEvent Interface

IUccContainerMembershipManager Interface

IUccContext Interface

IUccCredential Interface

IUccCredentialCache Interface

IUccDiagnosticInfo Interface

IUccDiagnosticReportingSettings Interface

IUccEndpoint Interface

IUccFindMediaConnectivityServersEvent Interface

IUccFindServerEvent Interface

IUccGroup Interface

IUccGroupMembershipEvent Interface

IUccIncomingInstantMessageEvent Interface

IUccIncomingInvitationEvent Interface

IUccIncomingMediaRequestEvent Interface

IUccIncomingRequestEvent Interface

IUccIncomingSessionEvent Interface

IUccIncomingSessionTransferEvent Interface

IUccIncomingSignalingMessageEvent Interface

IUccInstantMessagingComposingEvent Interface

IUccInstantMessagingSession Interface

IUccInstantMessagingSessionParticipant Interface

IUccInvitationAcceptedEvent Interface

IUccLocaleString Interface

IUccMediaChannel Interface

IUccMediaChannelCollectionEvent Interface

IUccMediaChannelDevices Interface

IUccMediaChannelEvent Interface

IUccMediaConnectivityServer Interface

IUccMediaConnectivityServerConfiguration Interface

IUccMediaDevice Interface

IUccMediaDeviceChangeEvent Interface

IUccMediaDeviceManager Interface

IUccMediaDeviceSettings Interface

IUccMediaEndpointSettings Interface

IUccOperationContext Interface

IUccOperationManager Interface

IUccOperationProgressEvent Interface

IUccOutgoingInvitationEvent Interface

IUccOutgoingSessionEvent Interface

IUccPlatform Interface

IUccPresenceActivity Interface

IUccPresenceCalendarDataInstance Interface

IUccPresenceCapabilities Interface

IUccPresenceCapabilityInfo Interface

IUccPresenceContactCardAddress Interface

IUccPresenceContactCardIdentity Interface

IUccPresenceContactCardInstance Interface

IUccPresenceContactCardPhone Interface

IUccPresenceContactCardUrl Interface

IUccPresenceDeviceInstance Interface

IUccPresenceFreeBusyInformation Interface

IUccPresenceNoteData Interface

IUccPresenceNoteInstance Interface

IUccPresencePhoneLine Interface

IUccPresenceServiceElement Interface

IUccPresenceServicesInstance Interface

IUccPresenceStateInstance Interface

IUccPresenceTimeZoneInformation Interface

IUccPresenceWorkingHoursBlock Interface

IUccPresenceWorkingHoursInformation Interface

IUccPresentity Interface

IUccProperty Interface

IUccPropertyCollection Interface

IUccPropertyUpdateEvent Interface

IUccProvisioningPolicyInstance Interface

IUccPublication Interface

IUccPublicationManager Interface

IUccReadOnlyPropertyCollection Interface

IUccRoutingPreamble Interface

IUccRoutingPreambleElement Interface

IUccRoutingPreambleFlagsElement Interface

IUccRoutingPreambleListElement Interface

IUccRoutingPreambleWaitElement Interface

IUccRoutingRuleElement Interface

IUccRoutingRuleInstance Interface

IUccRoutingTarget Interface

IUccServerConfigurationCategory Interface

IUccServerSignalingSettings Interface

IUccSession Interface

IUccSessionCallControl Interface

IUccSessionManager Interface

IUccSessionOperationEvent Interface

IUccSessionParticipant Interface

IUccSessionParticipantCollectionEvent Interface

IUccSessionParticipantEndpoint Interface

IUccSessionParticipantEndpointCollectionEvent Interface

IUccSessionParticipantOperationEvent Interface

IUccSessionParticipantStateChangedEvent Interface

IUccSessionTransferProgressEvent Interface

IUccSignalingChannel Interface

IUccSignalingChannelManager Interface

IUccSignalingHeaderField Interface

IUccSignalingHeaderFieldParameter Interface

IUccSignalingMessage Interface

IUccSignalingRequest Interface

IUccSignalingResponse Interface

IUccSignalingServer Interface

IUccSubscriber Interface

IUccSubscription Interface

IUccSubscriptionEvent Interface

IUccSubscriptionManager Interface

IUccTraceSettings Interface

IUccUri Interface

IUccUriManager Interface

IUccUserSearchManager Interface

IUccUserSearchQuery Interface

IUccUserSearchQueryEvent Interface

IUccUserSearchResultRecord Interface

IUccVideoMediaChannel Interface

IUccVideoMediaDevice Interface

UCC_AUDIO_VIDEO_DEVICE_CATEGORY Enumeration

UCC_AUTHENTICATION_MODES Enumeration

UCC_CATEGORY_CONTEXT_EVENT_CONTEXT Enumeration

UCC_CATEGORY_INSTANCE_EVENT_CONTEXT Enumeration

UCC_CATEGORY_INSTANCE_EXPIRE_TYPE Enumeration

UCC_CATEGORY_REMOVAL_EVENT_REASON Enumeration

UCC_CATEGORY_REMOVAL_REASON Enumeration

UCC_CHANNEL_CONTEXT Enumeration

UCC_CONFERENCE_ADMISSION_TYPE Enumeration

UCC_CONFERENCE_ENTITY_PROPERTY Enumeration

UCC_CONFERENCE_ENTITY_SETTING_PROPERTY Enumeration

UCC_CONFERENCE_ENTITY_STATE_PROPERTY Enumeration

UCC_CONFERENCE_ENTITY_TYPE Enumeration

UCC_CONFERENCE_INFORMATION_PROPERTY Enumeration

UCC_CONFERENCE_MANAGER_OPERATION_COMPLETED_EVENT_PROPERTY Enumeration

UCC_CONFERENCE_MEDIA_CHANNEL_PROPERTY Enumeration

UCC_CONFERENCE_MEDIA_FILTERS_RULE_PROPERTY Enumeration

UCC_CONFERENCE_MEDIA_JOIN_TYPE Enumeration

UCC_CONFERENCE_MEDIUM_PROPERTY Enumeration

UCC_CONFERENCE_PARTICIPANT_AUTHENTICATION_TYPE Enumeration

UCC_CONFERENCE_PARTICIPANT_ENDPOINT_CONTEXT Enumeration

UCC_CONFERENCE_PARTICIPANT_ENDPOINT_PROPERTY Enumeration

UCC_CONFERENCE_PARTICIPANT_PROPERTY Enumeration

UCC_CONFERENCE_PARTICIPANT_ROLE Enumeration

UCC_CONFERENCE_RECORDED_MEDIA_PROPERTY Enumeration

UCC_CONFERENCE_SESSION_PROPERTY Enumeration

UCC_CONFERENCE_VIDEO_SWITCHING_MODE Enumeration

UCC_CONTACT_CARD_ADDRESS_TYPE Enumeration

UCC_CONTACT_CARD_PHONE_TYPE Enumeration

UCC_CONTACT_CARD_URL_TYPE Enumeration

UCC_CONTAINER_MEMBER_COMPARE_RESULT Enumeration

UCC_CONTAINER_MEMBER_MATCHING_TYPE Enumeration

UCC_CONTAINER_MEMBERSHIP_SCOPE Enumeration

UCC_DIAGNOSTIC_INFO_TYPE Enumeration

UCC_DIAGNOSTIC_REPORTING_METHODS Enumeration

UCC_DTMF Enumeration

UCC_ENDPOINT_SIGNALING_CAPABILITIES Enumeration

UCC_ENDPOINT_TYPE Enumeration

UCC_FIND_MEDIA_CONNECTIVITY_SERVER_REQUEST_CONTEXT Enumeration

UCC_FIND_SERVER_CONTEXT Enumeration

UCC_GROUP_TYPE Enumeration

UCC_INCOMING_REQUEST_EVENT_CONTEXT Enumeration

UCC_MEDIA_CONNECTIVITY_SERVER_CONFIGURATION_CONTEXT Enumeration

UCC_MEDIA_CONNECTIVITY_SERVER_LOCATION Enumeration

UCC_MEDIA_CONNECTIVITY_SERVER_TYPE Enumeration

UCC_MEDIA_DEVICE_CHANGE_REASON Enumeration

UCC_MEDIA_DEVICE_PROPERTY Enumeration

UCC_MEDIA_DEVICE_SETTING_PROPERTY Enumeration

UCC_MEDIA_DIRECTIONS Enumeration

UCC_MEDIA_ENCRYPTION_LEVEL Enumeration

UCC_MEDIA_ENCRYPTION_MODES Enumeration

UCC_MEDIA_STREAM_STATE Enumeration

UCC_MEDIA_STREAM_STATE_CHANGE_REASON Enumeration

UCC_MEDIA_TYPES Enumeration

UCC_OPERATION_CONTEXT Enumeration

UCC_OPERATION_PROGRESS_EVENT_CONTEXT Enumeration

UCC_PARTICIPANT_STATE_CHANGE_REASON Enumeration

UCC_PLATFORM_CONTEXT Enumeration

UCC_PRESENCE_AVAILABILITY Enumeration

UCC_PRESENCE_CATEGORY_TYPE Enumeration

UCC_PRESENCE_DEVICE_CAPABILITIES Enumeration

UCC_PRESENCE_NOTE_TYPE Enumeration

UCC_PRESENCE_PHONE_LINE_TYPE Enumeration

UCC_PRESENCE_STATE_TYPE Enumeration

UCC_PRESENCE_WORKING_HOURS_DAYS Enumeration

UCC_PRESENCE_WORKING_HOURS_TIMEZONE_TYPE Enumeration

UCC_PROPERTY_ACCESSIBILITY Enumeration

UCC_PROPERTY_CLASS Enumeration

UCC_PROPERTY_MASK Enumeration

UCC_PROPERTY_MASK_INDEX Enumeration

UCC_PROPERTY_TYPE Enumeration

UCC_PROXY_ENDPOINT_CONTEXT_EXTENSIONS Enumeration

UCC_PUBLICATION_OPERATION_TYPE Enumeration

UCC_REJECT_OR_TERMINATE_REASON Enumeration

UCC_ROUTING_PREAMBLE_ELEMENT_TYPE Enumeration

UCC_ROUTING_RULE_ELEMENT_TYPE Enumeration

UCC_SERVER_ENDPOINT_CONTEXT Enumeration

UCC_SERVER_ENDPOINT_FLAGS Enumeration

UCC_SESSION_CONTEXT Enumeration

UCC_SESSION_ENTITY_STATE Enumeration

UCC_SESSION_REDIRECT_METHOD Enumeration

UCC_SESSION_TYPE Enumeration

UCC_SIGNALING_MESSAGE_TYPE Enumeration

UCC_SIGNALING_REQUEST_TYPE Enumeration

UCC_SOURCE_NETWORK_TYPE Enumeration

UCC_SUBSCRIPTION_CONTEXT Enumeration

UCC_TELEPHONY_DEVICE_SUB_TYPES Enumeration

UCC_TRANSFER_CONTEXT Enumeration

UCC_TRANSPORT_MODE Enumeration

UCC_TUNING_WIZARD_PAGE Enumeration

UCC_URI_COMPARISON_OPTION Enumeration

UCC_URI_SCHEME Enumeration

UCC_USER_SEARCH_COLUMN Enumeration

UCC_USER_SEARCH_PREFERENCE Enumeration

UCC_VIDEO_TYPE Enumeration

UccApplicationSession Class

UccApplicationSessionParticipant Class

UccAudioMediaChannel Class

UccAudioMediaDevice Class

UccAudioSignalLevelChangedEvent Class

UccAudioVideoMediaChannelSourceEvent Class

UccAudioVideoMediaChannelStreamsEvent Class

UccAudioVideoSession Class

UccAudioVideoSessionParticipant Class

UccCategoryContext Class

UccCategoryContextEvent Class

UccCategoryInstance Class

UccCategoryInstanceEvent Class

UccConferenceEntityView Class

UccConferenceEntityViewCollectionEvent Class

UccConferenceInformation Class

UccConferenceManagerSession Class

UccConferenceMediaChannel Class

UccConferenceSession Class

UccConferenceSessionParticipant Class

UccConferenceSessionParticipantEndpoint Class

UccConferenceSessionParticipantEndpointStateChangedEvent Class

UccConferenceView Class

UccConstants Class

UccContact Class

UccContactCollectionEvent Class

UccContainerMemberCollectionEvent Class

UccContainerMembershipEvent Class

UccContext Class

UccCredential Class

UccCredentialCache Class

UccDiagnosticInfo Class

UccFindServerEvent Class

UccGroupMembershipEvent Class

UccIncomingInstantMessageEvent Class

UccIncomingInvitationEvent Class

UccIncomingMediaRequestEvent Class

UccIncomingSessionEvent Class

UccIncomingSessionTransferEvent Class

UccInstantMessagingComposingEvent Class

UccInstantMessagingSession Class

UccInstantMessagingSessionParticipant Class

UccInvitationAcceptedEvent Class

UccLocaleString Class

UccMediaChannelEvent Class

UccMediaConnectivityServer Class

UccMediaDeviceChangeEvent Class

UccOperationContext Class

UccOperationProgressEvent Class

UccOutgoingInvitationEvent Class

UccOutgoingSessionEvent Class

UccPlatform Class

UccPresenceActivity Class

UccPresenceCalendarDataInstance Class

UccPresenceCapabilities Class

UccPresenceCapabilityInfo Class

UccPresenceContactCardAddress Class

UccPresenceContactCardIdentity Class

UccPresenceContactCardInstance Class

UccPresenceContactCardPhone Class

UccPresenceContactCardUrl Class

UccPresenceDeviceInstance Class

UccPresenceFreeBusyInformation Class

UccPresenceNoteData Class

UccPresenceNoteInstance Class

UccPresencePhoneLine Class

UccPresenceServiceElement Class

UccPresenceServicesInstance Class

UccPresenceStateInstance Class

UccPresenceTimeZoneInformation Class

UccPresenceWorkingHoursBlock Class

UccPresenceWorkingHoursInformation Class

UccPresentity Class

UccProperty Class

UccPropertyCollection Class

UccPropertyUpdateEvent Class

UccProvisioningPolicyInstance Class

UccProxyEndpoint Class

UccRemoteCallControlAudioChannel Class

UccRemoteCallControlSession Class

UccRemoteCallControlSessionParticipant Class

UccRoutingPreamble Class

UccRoutingPreambleFlagsElement Class

UccRoutingPreambleListElement Class

UccRoutingPreambleWaitElement Class

UccRoutingRuleInstance Class

UccRoutingTarget Class

UccServerConfigurationCategory Class

UccServerEndpoint Class

UccSessionOperationEvent Class

UccSessionParticipantCollectionEvent Class

UccSessionParticipantEndpointCollectionEvent Class

UccSessionParticipantOperationEvent Class

UccSessionParticipantStateChangedEvent Class

UccSessionTransferProgressEvent Class

UccSignalingChannel Class

UccSignalingHeaderField Class

UccSignalingHeaderFieldParameter Class

UccSignalingRequest Class

UccSignalingResponse Class

UccSubscription Class

UccSubscriptionEvent Class

UccUri Class

UccUriManager Class

UccUserSearchQuery Class

UccUserSearchQueryEvent Class

UccUserSearchResultRecord Class

UccVideoMediaChannel Class

UccVideoMediaDevice Class

Minimize

This topic has not yet been rated - Rate this topic

UCC_SUBSCRIPTION_CONTEXT Enumeration

Enumerates the IDs of the extended properties of a subscription.

Namespace: Microsoft.Office.Interop.UccApi
Assembly: Microsoft.Office.Interop.UccApi (in microsoft.office.interop.uccapi.dll)

'Declaration
Public Enumeration UCC_SUBSCRIPTION_CONTEXT

public enum UCC_SUBSCRIPTION_CONTEXT

public enum UCC_SUBSCRIPTION_CONTEXT

Member name	Description
UCCSC_RETRY_TIMEOUT	The ID of a property of an integer value describing the retry timeout in seconds. The default value is 30 seconds.
UCCSC_THROTTLE_LIMIT	The ID of a property of an integer value describing the throttling limit in seconds. The minimum of this property value is 120 seconds or 2 minutes.

A SUBSCRIBE request in a subscription fails when the underlying server is down or other errors occur. In such cases the UCC API resubmits the request periodically until the request succeeds. This process is known as subscription Retry. The period of Retry is known as Retry Timeout. Its value is specified by the UCCSC_RETRY_TIMEOUT property defined in this enumeration type. In a polling subscription the UCC API throttles the Query requests to control how often such a request is sent to the server. The frequency is determined by the UCCSC_THROTTLE_LIMIT property defined here. For example, a client calls Query twice in 30 seconds. The API will delays sending the second request for a time period specified by the UCCSC_THROTTLE_LIMIT property value. Because of throttling a client can get the results of a Query request that can be at minimum two minutes stale.

Win32 COM/C++ Syntax

typedef enum UCC_SUBSCRIPTION_CONTEXT
{
   UCCSC_RETRY_TIMEOUT = 1,
   UCCSC_THROTTLE_LIMIT = 2
};

Development Platforms

Windows XP Professional with Service Pack 2 (SP2), Windows Server 2000 with Service Pack 4, Windows Server 2003, Windows Vista Ultimate Edition, Windows Vista Business Edition, Windows Vista Enterprise Edition

Target Platforms

Reference

Microsoft.Office.Interop.UccApi Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

© 2013 Microsoft. All rights reserved.