ExchangeService.GetClientExtension Method

Definition

Gets client extension information. This method is used in server-to-server calls to retrieve organization extensions for the administrator's Windows PowerShell or Exchange Unified Management Console (UMC) access and for the user's Windows PowerShell or UMC access, as well as user's activation for Outlook Web Access (OWA) or Outlook. This method is not expected to be used or called directly from a user client. The GetClientExtension(StringList, Boolean, Boolean, String, StringList, StringList, Boolean) method is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

public:
 Microsoft::Exchange::WebServices::Data::GetClientExtensionResponse ^ GetClientExtension(Microsoft::Exchange::WebServices::Data::StringList ^ requestedExtensionIds, bool shouldReturnEnabledOnly, bool isUserScope, System::String ^ userId, Microsoft::Exchange::WebServices::Data::StringList ^ userEnabledExtensionIds, Microsoft::Exchange::WebServices::Data::StringList ^ userDisabledExtensionIds, bool isDebug);
public Microsoft.Exchange.WebServices.Data.GetClientExtensionResponse GetClientExtension (Microsoft.Exchange.WebServices.Data.StringList requestedExtensionIds, bool shouldReturnEnabledOnly, bool isUserScope, string userId, Microsoft.Exchange.WebServices.Data.StringList userEnabledExtensionIds, Microsoft.Exchange.WebServices.Data.StringList userDisabledExtensionIds, bool isDebug);
Public Function GetClientExtension (requestedExtensionIds As StringList, shouldReturnEnabledOnly As Boolean, isUserScope As Boolean, userId As String, userEnabledExtensionIds As StringList, userDisabledExtensionIds As StringList, isDebug As Boolean) As GetClientExtensionResponse

Parameters

requestedExtensionIds
StringList

A set of extension IDs.

shouldReturnEnabledOnly
Boolean

true if only enabled extensions are returned; otherwise, false.

isUserScope
Boolean

true if authentication is that of the associated user; otherwise, if authenticating with administrator access, false.

userId
String

An optional user identity that allows filtering in cases where an administrator installs an extension for specific users.

userEnabledExtensionIds
StringList

An optional list of organization extension IDs that can be enabled by users. This is used for results filtering.

userDisabledExtensionIds
StringList

Optional list of organization extension IDs that can be disabled by users. This is used for results filtering.

isDebug
Boolean

true if the organization master table in the arbitration mailbox should be returned for debug purposes; otherwise, false.

Returns

A GetClientExtensionResponse object.

Applies to