MediaWikiFormRequestMessage Class

This is preliminary documentation and is subject to change.

The MediaWiki API request message consisting of parameter key-value pairs (fields).

Inheritance Hierarchy

SystemObject
WikiClientLibrary.ClientWikiRequestMessage
WikiClientLibrary.ClientMediaWikiFormRequestMessage

Namespace: WikiClientLibrary.Client
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.9.0-int.2+447d1d590e6726b7881f750a0a0e42908f3e417e

Syntax

C++

Copy

public class MediaWikiFormRequestMessage : WikiRequestMessage

Public Class MediaWikiFormRequestMessage
	Inherits WikiRequestMessage

Dim instance As MediaWikiFormRequestMessage

public ref class MediaWikiFormRequestMessage : public WikiRequestMessage

type MediaWikiFormRequestMessage = 
    class
        inherit WikiRequestMessage
    end

The MediaWikiFormRequestMessage type exposes the following members.

Constructors

	Name	Description
	MediaWikiFormRequestMessage(Object)	Initializes a new instance of the MediaWikiFormRequestMessage class
	MediaWikiFormRequestMessage(Object, Boolean)	Initializes a new instance of the MediaWikiFormRequestMessage class
	MediaWikiFormRequestMessage(String, Object, Boolean)	Initializes a new instance of the MediaWikiFormRequestMessage class

Top

Properties

	Name	Description
	AsMultipartFormData	Determines whether this message should be marshaled in multipart/form-data MIME type.
	Fields	Gets a read-only list of all the fields in the form.
	Id	Id of the request, for tracing. (Inherited from WikiRequestMessage)

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetHttpContent	Gets the HttpContent corresponding to this message. (Overrides WikiRequestMessageGetHttpContent)
	GetHttpMethod	Gets the HTTP method used to send the request. (Overrides WikiRequestMessageGetHttpMethod)
	GetHttpQuery	Gets the URI query part for the endpoint invocation. (Overrides WikiRequestMessageGetHttpQuery)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ToString	Returns a string that represents the current object. (Inherited from WikiRequestMessage)

Top

Remarks

This is the primary message type used in the WikiClientLibrary. This type provides some useful functionalities such as constructing fields from anonymous objects, and simple type (e.g. DateTime) marshalling. while overriding the rest.

This message can be later converted into application/x-www-form-urlencoded or multipart/form-data http content.

When converting the form into HttpContent, the values are marshaled in the following way

null values are ignored.
string values are kept intact.
bool values are marshaled as ""(Empty) for true, and are ignored for false.
DateTime values are marshaled as UTC in ISO 8601 format.
Stream values are sent as StreamContent with a dummy file name, and this will force the whole form to be marshaled as MultipartFormDataContent.
JsonContent values are sent as JSON string content. (Not implemented yet)
AutoWatchBehavior values are marshaled as one of "preferences", "nochange", "watch", "unwatch".
Other types of values are marshaled by calling ToString on them.

Note that the message sending methods (e.g. InvokeMediaWikiApiAsync(WikiRequestMessage, CancellationToken)) may also change the way the message is marshaled. For the detailed information, please see the message sender's documentations respectively.

This message uses POST method to invoke API requests.

Reference

WikiClientLibrary.Client Namespace