Class ClientSyncWebService

Update server implementation. Provides updates to Windows Update clients.

The communication protocol with clients is SOAP.

Inheritance

System.Object

ClientSyncWebService

Namespace: Microsoft.PackageGraph.MicrosoftUpdate.Endpoints.ClientSync

Assembly: package-graph-endpoints-microsoft-update.dll

Syntax

public class ClientSyncWebService

Constructors

| Improve this Doc View Source

ClientSyncWebService()

Default constructor

Declaration

public ClientSyncWebService()

Properties

| Improve this Doc View Source

MetadataSource

The local repository from where updates are served.

Declaration

public IMetadataStore MetadataSource { get; }

Property Value

Type	Description
IMetadataStore

Methods

| Improve this Doc View Source

AddApprovedDriverUpdate(MicrosoftUpdatePackageIdentity)

Adds an update identities to the list of approved driver updates. Approved updates are made available to clients connecting to this service.

Declaration

public void AddApprovedDriverUpdate(MicrosoftUpdatePackageIdentity approvedUpdate)

Parameters

Type	Name	Description
MicrosoftUpdatePackageIdentity	approvedUpdate	Approved driver update

| Improve this Doc View Source

AddApprovedDriverUpdates(IEnumerable<MicrosoftUpdatePackageIdentity>)

Adds a list of update identities to the list of approved driver updates. Approved updates are made available to clients connecting to this service.

Declaration

public void AddApprovedDriverUpdates(IEnumerable<MicrosoftUpdatePackageIdentity> approvedUpdates)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<MicrosoftUpdatePackageIdentity>	approvedUpdates

| Improve this Doc View Source

AddApprovedSoftwareUpdate(MicrosoftUpdatePackageIdentity)

Adds an update identity to the list of approved software updates. Approved updates are made available to clients connecting to this service.

Declaration

public void AddApprovedSoftwareUpdate(MicrosoftUpdatePackageIdentity approvedUpdate)

Parameters

Type	Name	Description
MicrosoftUpdatePackageIdentity	approvedUpdate	Approved update

| Improve this Doc View Source

AddApprovedSoftwareUpdates(IEnumerable<MicrosoftUpdatePackageIdentity>)

Adds a list of update identities to the list of approved software updates. Approved updates are made available to clients connecting to this service.

Declaration

public void AddApprovedSoftwareUpdates(IEnumerable<MicrosoftUpdatePackageIdentity> approvedUpdates)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<MicrosoftUpdatePackageIdentity>	approvedUpdates	List of approved updates

| Improve this Doc View Source

ClearApprovedDriverUpdates()

Clears the list of approved driver updates. Un-approved updates are not made available to connecting clients.

Declaration

public void ClearApprovedDriverUpdates()

| Improve this Doc View Source

ClearApprovedSoftwareUpdates()

Clears the list of approved software updates. Un-approved updates are not made available to connecting clients.

Declaration

public void ClearApprovedSoftwareUpdates()

| Improve this Doc View Source

GetConfig2Async(ClientConfiguration)

Handle get configuration requests from clients

Declaration

public Task<Config> GetConfig2Async(ClientConfiguration clientConfiguration)

Parameters

Type	Name	Description
Microsoft.UpdateServices.WebServices.ClientSync.ClientConfiguration	clientConfiguration	The client configuration as received from a Windows client

Returns

Type	Description
System.Threading.Tasks.Task<Microsoft.UpdateServices.WebServices.ClientSync.Config>	The server configuration to be sent to a Windows client

| Improve this Doc View Source

GetConfigAsync(String)

Handle get configuration requests from clients

Declaration

public Task<Config> GetConfigAsync(string protocolVersion)

Parameters

Type	Name	Description
System.String	protocolVersion	The version of the Windows client connecting to this server

Returns

Type	Description
System.Threading.Tasks.Task<Microsoft.UpdateServices.WebServices.ClientSync.Config>	The server configuration to be sent to a Windows client

| Improve this Doc View Source

GetCookieAsync(AuthorizationCookie[], Cookie, DateTime, DateTime, String)

Handle get cookie requests. All requests are all granted access and a cookie is issued.

Declaration

public Task<Cookie> GetCookieAsync(AuthorizationCookie[] authCookies, Cookie oldCookie, DateTime lastChange, DateTime currentTime, string protocolVersion)

Parameters

Type	Name	Description
Microsoft.UpdateServices.WebServices.ClientSync.AuthorizationCookie[]	authCookies	Authorization cookies received from the client
Microsoft.UpdateServices.WebServices.ClientSync.Cookie	oldCookie	Old cookie from client
System.DateTime	lastChange
System.DateTime	currentTime
System.String	protocolVersion	Client supported protocol version

Returns

Type	Description
System.Threading.Tasks.Task<Microsoft.UpdateServices.WebServices.ClientSync.Cookie>	A new cookie

| Improve this Doc View Source

GetExtendedUpdateInfo2Async(Cookie, UpdateIdentity[], XmlUpdateFragmentType[], String[], String)

Not implemented.

Declaration

public Task<ExtendedUpdateInfo2> GetExtendedUpdateInfo2Async(Cookie cookie, UpdateIdentity[] updateIDs, XmlUpdateFragmentType[] infoTypes, string[] locales, string deviceAttributes)

Parameters

Type	Name	Description
Microsoft.UpdateServices.WebServices.ClientSync.Cookie	cookie	Not implemented
Microsoft.UpdateServices.WebServices.ClientSync.UpdateIdentity[]	updateIDs	Not implemented
Microsoft.UpdateServices.WebServices.ClientSync.XmlUpdateFragmentType[]	infoTypes	Not implemented
System.String[]	locales	Not implemented
System.String	deviceAttributes	Not implemented

Returns

Type	Description
System.Threading.Tasks.Task<Microsoft.UpdateServices.WebServices.ClientSync.ExtendedUpdateInfo2>	Not implemented

| Improve this Doc View Source

GetExtendedUpdateInfoAsync(Cookie, Int32[], XmlUpdateFragmentType[], String[], String)

Handle requests for extended update information. The extended information is extracted from update metadata. Extended information also includes file URLs

Declaration

public Task<ExtendedUpdateInfo> GetExtendedUpdateInfoAsync(Cookie cookie, int[] revisionIDs, XmlUpdateFragmentType[] infoTypes, string[] locales, string deviceAttributes)

Parameters

Type	Name	Description
Microsoft.UpdateServices.WebServices.ClientSync.Cookie	cookie	Access cookie
System.Int32[]	revisionIDs	Revision Ids for which to get extended information
Microsoft.UpdateServices.WebServices.ClientSync.XmlUpdateFragmentType[]	infoTypes	The type of extended information requested
System.String[]	locales	The language to use when getting language dependent extended information
System.String	deviceAttributes	Device attributes; unused

Returns

Type	Description
System.Threading.Tasks.Task<Microsoft.UpdateServices.WebServices.ClientSync.ExtendedUpdateInfo>	Extended update information response.

| Improve this Doc View Source

GetFileLocationsAsync(Cookie, Byte[][])

Not implemented

Declaration

public Task<GetFileLocationsResults> GetFileLocationsAsync(Cookie cookie, byte[][] fileDigests)

Parameters

Type	Name	Description
Microsoft.UpdateServices.WebServices.ClientSync.Cookie	cookie
System.Byte[][]	fileDigests

Returns

Type	Description
System.Threading.Tasks.Task<Microsoft.UpdateServices.WebServices.ClientSync.GetFileLocationsResults>	Not implemented

| Improve this Doc View Source

GetTimestampsAsync(GetTimestampsRequest)

Not implemented

Declaration

public Task<GetTimestampsResponse> GetTimestampsAsync(GetTimestampsRequest request)

Parameters

Type	Name	Description
Microsoft.UpdateServices.WebServices.ClientSync.GetTimestampsRequest	request

Returns

Type	Description
System.Threading.Tasks.Task<Microsoft.UpdateServices.WebServices.ClientSync.GetTimestampsResponse>	Not implemented

| Improve this Doc View Source

RefreshCacheAsync(Cookie, UpdateIdentity[], String)

Not implemented

Declaration

public Task<RefreshCacheResult[]> RefreshCacheAsync(Cookie cookie, UpdateIdentity[] globalIDs, string deviceAttributes)

Parameters

Type	Name	Description
Microsoft.UpdateServices.WebServices.ClientSync.Cookie	cookie
Microsoft.UpdateServices.WebServices.ClientSync.UpdateIdentity[]	globalIDs
System.String	deviceAttributes

Returns

Type	Description
System.Threading.Tasks.Task<Microsoft.UpdateServices.WebServices.ClientSync.RefreshCacheResult[]>	Not implemented

| Improve this Doc View Source

RegisterComputerAsync(Cookie, ComputerInfo)

Not implemented

Declaration

public Task RegisterComputerAsync(Cookie cookie, ComputerInfo computerInfo)

Parameters

Type	Name	Description
Microsoft.UpdateServices.WebServices.ClientSync.Cookie	cookie
Microsoft.UpdateServices.WebServices.ClientSync.ComputerInfo	computerInfo

Returns

Type	Description
System.Threading.Tasks.Task	Not implemented

| Improve this Doc View Source

RemoveApprovedDriverUpdate(MicrosoftUpdatePackageIdentity)

Removes an approved software update from the list of approved software updates. The software update will not be given to connecting clients anymore.

Declaration

public void RemoveApprovedDriverUpdate(MicrosoftUpdatePackageIdentity updateIdentity)

Parameters

Type	Name	Description
MicrosoftUpdatePackageIdentity	updateIdentity	Identity of update to un-approve

| Improve this Doc View Source

RemoveApprovedSoftwareUpdate(MicrosoftUpdatePackageIdentity)

Removes an approved software update from the list of approved software updates. The software update will not be given to connecting clients anymore.

Declaration

public void RemoveApprovedSoftwareUpdate(MicrosoftUpdatePackageIdentity updateIdentity)

Parameters

Type	Name	Description
MicrosoftUpdatePackageIdentity	updateIdentity	Identity of update to un-approve

| Improve this Doc View Source

SetContentURLBase(String)

Sets the host name for the server that serves the update content

Declaration

public void SetContentURLBase(string hostName)

Parameters

Type	Name	Description
System.String	hostName

| Improve this Doc View Source

SetPackageStore(IMetadataStore)

Sets the source of update metadata

Declaration

public void SetPackageStore(IMetadataStore metadataSource)

Parameters

Type	Name	Description
IMetadataStore	metadataSource	The source for updates metadata

| Improve this Doc View Source

SetServiceConfiguration(Config)

Sets the service configuratoin

Declaration

public void SetServiceConfiguration(Config serviceConfiguration)

Parameters

Type	Name	Description
Microsoft.UpdateServices.WebServices.ClientSync.Config	serviceConfiguration	Service configuration

| Improve this Doc View Source

StartCategoryScanAsync(StartCategoryScanRequest)

Not implemented

Declaration

public Task<StartCategoryScanResponse> StartCategoryScanAsync(StartCategoryScanRequest request)

Parameters

Type	Name	Description
Microsoft.UpdateServices.WebServices.ClientSync.StartCategoryScanRequest	request

Returns

Type	Description
System.Threading.Tasks.Task<Microsoft.UpdateServices.WebServices.ClientSync.StartCategoryScanResponse>	Not implemented

| Improve this Doc View Source

SyncPrinterCatalogAsync(Cookie, Int32[], Int32[], String)

Not implemented

Declaration

public Task<SyncInfo> SyncPrinterCatalogAsync(Cookie cookie, int[] installedNonLeafUpdateIDs, int[] printerUpdateIDs, string deviceAttributes)

Parameters

Type	Name	Description
Microsoft.UpdateServices.WebServices.ClientSync.Cookie	cookie
System.Int32[]	installedNonLeafUpdateIDs
System.Int32[]	printerUpdateIDs
System.String	deviceAttributes

Returns

Type	Description
System.Threading.Tasks.Task<Microsoft.UpdateServices.WebServices.ClientSync.SyncInfo>	Not implemented

| Improve this Doc View Source

SyncUpdatesAsync(Cookie, SyncUpdateParameters)

Handle requests to sync updates. A client presents the list of installed updates and detectoids and the server replies with a list of more applicable updates, if any.

Declaration

public Task<SyncInfo> SyncUpdatesAsync(Cookie cookie, SyncUpdateParameters parameters)

Parameters

Type	Name	Description
Microsoft.UpdateServices.WebServices.ClientSync.Cookie	cookie	Access cookie
Microsoft.UpdateServices.WebServices.ClientSync.SyncUpdateParameters	parameters	Request parameters: list of installed updates, list of known updates, etc.

Returns

Type	Description
System.Threading.Tasks.Task<Microsoft.UpdateServices.WebServices.ClientSync.SyncInfo>	SyncInfo containing updates applicable to the caller.

Events

| Improve this Doc View Source

OnUnApprovedDriverUpdatesRequested

Event raised when driver updates are applicable to a client but are not approved for distribution

Declaration

public event ClientSyncWebService.UnApprovedUpdatesRequestedDelegate OnUnApprovedDriverUpdatesRequested

Event Type

Type	Description
ClientSyncWebService.UnApprovedUpdatesRequestedDelegate

| Improve this Doc View Source

OnUnApprovedSoftwareUpdatesRequested

Event raised when software updates are applicable to a client but are not approved for distribution

Declaration

public event ClientSyncWebService.UnApprovedUpdatesRequestedDelegate OnUnApprovedSoftwareUpdatesRequested

Event Type

Type	Description
ClientSyncWebService.UnApprovedUpdatesRequestedDelegate