Admin.UpdateUserSyncSetting Method

  • Article

Updates the setting for user synchronization with SharePoint Server 2010.

Namespace:  [Admin Web service]
Service reference: http://ServerName:32843/[Project Service Application GUID]/PSI/Admin.svc
Web service reference: http://ServerName/ProjectServerName/_vti_bin/PSI/Admin.asmx?wsdl

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/office/project/server/webservices/Admin/UpdateUserSyncSetting", RequestNamespace := "https://schemas.microsoft.com/office/project/server/webservices/Admin/",  _
    ResponseNamespace := "https://schemas.microsoft.com/office/project/server/webservices/Admin/",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Sub UpdateUserSyncSetting ( _
    userSyncSetting As UserSyncSettings _
)
'Usage
Dim instance As Admin
Dim userSyncSetting As UserSyncSettings

instance.UpdateUserSyncSetting(userSyncSetting)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/office/project/server/webservices/Admin/UpdateUserSyncSetting", RequestNamespace = "https://schemas.microsoft.com/office/project/server/webservices/Admin/", 
    ResponseNamespace = "https://schemas.microsoft.com/office/project/server/webservices/Admin/", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public void UpdateUserSyncSetting(
    UserSyncSettings userSyncSetting
)

Parameters

Remarks

The enumeration members can be combined with the Or (|) operator to disable more than one synchronization setting.

Project Server Permissions

Permission

Description

ManageWindowsSharePointServices

Allows a user to manage the project site. Global permission.

Examples

The following example shows the use of the UpdateUserSyncSettings method. It disables synchronization with email and project sites, for the application user. SvcAdmin is the namespace of the Admin service in the ProjectServerServices.dll proxy assembly. For information about creating a PSI proxy assembly and an app.config file, see Prerequisites for WCF-Based Code Samples.

using System;
using System.Text;

namespace Microsoft.SDK.Project.Samples.UpdateUserSyncSetting
{
    class Program
    {
        private const string ENDPOINT = "basicHttp_Admin";

        private static SvcAdmin.AdminClient adminClient;

        static void Main(string[] args)
        {
            ConfigClientEndpoints(ENDPOINT);

            int syncSettings = (int)SvcAdmin.UserSyncSettings.DisableEmailSync
                | (int)SvcAdmin.UserSyncSettings.DisablePWS;

            Console.WriteLine("SyncSettings value: {0}", syncSettings.ToString());

            adminClient.UpdateUserSyncSetting((SvcAdmin.UserSyncSettings)syncSettings);

            Console.Write("\nPress any key to exit... ");
            Console.ReadKey(true);
        }

        // Use the endpoints that are defined in app.config to configure the client.
        public static void ConfigClientEndpoints(string endpt)
        {
            adminClient = new SvcAdmin.AdminClient(endpt);
        }
    }
}

The console output is: SyncSettings = 12

See Also

Reference

Admin Class

Admin Members

Admin Web Service