AtomPubClient Class

Definition

Namespace:

Windows.Web.AtomPub

Encapsulates the methods needed to implement the AtomPub protocol which enables HTTP CRUD access to Web resources using the Atom 1.0 wire format.

public ref class AtomPubClient sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Activatable(Windows.Web.AtomPub.IAtomPubClientFactory, 65536, "Windows.Foundation.UniversalApiContract")]
class AtomPubClient final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Activatable(typeof(Windows.Web.AtomPub.IAtomPubClientFactory), 65536, "Windows.Foundation.UniversalApiContract")]
public sealed class AtomPubClient

function AtomPubClient(serverCredential)

Public NotInheritable Class AtomPubClient

Inheritance

Object Platform::Object IInspectable AtomPubClient

Attributes

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implements

ISyndicationClient

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)
App capabilities	internetClient privateNetworkClientServer

Remarks

For examples of how these class methods are implemented to create, retrieve, update, or delete syndicated content, see Quickstart: Managing Feed Entries.

Constructors

AtomPubClient()	Creates a new AtomPubClient object.
AtomPubClient(PasswordCredential)	Creates a new AtomPubClient object with the credential to use when making requests to the server. Initially, a 'username/password' tuple. However, for domain credentials, the username must be in 'domain\user form'.

Properties

BypassCacheOnRetrieve	Gets or sets a Boolean value that specifies whether to bypass the cache when retrieving the feed.
MaxResponseBufferSize	Gets or sets the maximum number of bytes to buffer when receiving a response from a server.
ProxyCredential	Gets or sets the credentials to use when making requests via a proxy.
ServerCredential	Gets or sets the credentials to use when making requests to the server.
Timeout	Gets or sets the maximum amount of time, in milliseconds, to wait for any of the asynchronous operations to complete. If the operation is not complete within this amount of time, it will fail with a status code indicating that it timed out.

Methods

CancelAsyncOperations()	Cancels any in-progress asynchronous operations, causing them to fail (asynchronously) with an error code indicating cancellation.
CreateMediaResourceAsync(Uri, String, String, IInputStream)	Creates a new media resource in the specified collection.
CreateResourceAsync(Uri, String, SyndicationItem)	Creates a new Entry resource in the specified collection. The Uri of the collection in which to create the new resource can be discovered from the ResourceCollection object retrieved from the RetrieveResourceAsync method.
DeleteResourceAsync(Uri)	Deletes an existing Entry or Media Link resource.
DeleteResourceItemAsync(SyndicationItem)	Deletes an existing Entry or Media Link resource. This differs from the DeleteResourceAsync method in that the SyndicationItem object that represents the resource to be deleted is specified instead of the Uri. The DeleteResourceItemAsync method uses the property of the specified SyndicationItem as the Uri of the resource to be deleted.
RetrieveFeedAsync(Uri)	Starts an asynchronous operation to download the syndication feed from the given URI. This method instantiates a SyndicationFeed object from the feed string, which can be in one of the formats specified in SyndicationFormat.
RetrieveMediaResourceAsync(Uri)	Retrieves a media link resource from the specified Uniform Resource Identifier (URI).
RetrieveResourceAsync(Uri)	Retrieves an Entry resource or Media Link resource from the specified Uniform Resource Identifier (URI).
RetrieveServiceDocumentAsync(Uri)	Retrieves a service document from the specified Uri.
SetRequestHeader(String, String)	Sets an HTTP header for the request. This method can be called multiple times to set multiple headers. When the same header is set multiple times, the values will be concatenated and separated by ",".
UpdateMediaResourceAsync(Uri, String, IInputStream)	Updates a media link resource from the specified Uniform Resource Identifier (URI).
UpdateResourceAsync(Uri, SyndicationItem)	Updates an existing Entry or Media Link resource. If an ETag: header has previously been seen while retrieving this resource (in a response to RetrieveResourceAsync, CreateResourceAsync or a previous call to UpdateResourceAsync), this method automatically sends an If-Match: header with the remembered value.
UpdateResourceItemAsync(SyndicationItem)	Updates an existing Entry or Media Link resource. This differs from the UpdateResourceAsync method in that the EditUri property of the specified SyndicationItem object is used as the Uri of the resource to be updated.

See also

• Quickstart: Managing Feed Entries
• AtomPub sample