WikiFamily Class

This is preliminary documentation and is subject to change.

Provides a simple IWikiFamily implementation based on a list of API endpoint URLs.

Inheritance Hierarchy

SystemObject
WikiClientLibrary.SitesWikiFamily

Namespace: WikiClientLibrary.Sites
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.9.0-int.4+fbadc980737ddc9bb67116900ecad57f84a0b241

Syntax

C++

Copy

public class WikiFamily : IWikiFamily, IWikiClientLoggable, 
	IReadOnlyCollection<string>, IEnumerable<string>, IEnumerable

Public Class WikiFamily
	Implements IWikiFamily, IWikiClientLoggable, IReadOnlyCollection(Of String), 
	IEnumerable(Of String), IEnumerable

Dim instance As WikiFamily

public ref class WikiFamily : IWikiFamily, 
	IWikiClientLoggable, IReadOnlyCollection<String^>, IEnumerable<String^>, 
	IEnumerable

type WikiFamily = 
    class
        interface IWikiFamily
        interface IWikiClientLoggable
        interface IReadOnlyCollection<string>
        interface IEnumerable<string>
        interface IEnumerable
    end

The WikiFamily type exposes the following members.

Constructors

	Name	Description
	WikiFamily(IWikiClient)	Initializes the instance with a WikiClient and family name.
	WikiFamily(IWikiClient, String)	Initializes the instance with a WikiClient and family name.

Top

Properties

	Name	Description
	Count	Gets the number of elements in the collection.
	Logger	Replaces the logger factory of the specified instance.
	Name	Gets the name of this wiki family.
	WikiClient

Top

Methods

	Name	Description
	CreateSiteAsync	Asynchronously create a WikiSite instance.
	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)
	GetEnumerator	Returns an enumerator that iterates through the collection.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetSiteAsync	Asynchronously gets a WikiSite instance from the specified family name. (Case-insensitive) This method will create the Site instance, if necessary; otherwise it will return the created one.
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	OnSiteCreated	Raises SiteCreated event.
	Register	Add a new wiki site into this family.
	ToString	Returns a string that represents the current object. (Inherited from Object)
	TryNormalize	Tries to normalize the specified wiki prefix by changing the letter-case of the input name.

Top

Events

	Name	Description
	SiteCreated	Raised when a new WikiSite has been instantiated, but before it is stored into the site cache.

Top

Extension Methods

	Name	Description
	BeginActionScope	Invokes BeginScopeTState(TState) with the current action(method) name and parameters. (Defined by WikiLoggingHelper)
	BeginActionScope	(Defined by WikiLoggingHelper)
	BeginActionScope	Invokes BeginScopeTState(TState) on the Logger with the current action(method) name and parameters. (Defined by WikiLoggingHelper)
	BeginActionScope	(Defined by WikiLoggingHelper)
	BeginActionScope	Invokes BeginScopeTState(TState) on the Logger with the current action(method) name and parameters. (Defined by WikiLoggingHelper)

Top

Explicit Interface Implementations

	Name	Description
	IEnumerableGetEnumerator	Returns an enumerator that iterates through a collection.

Top

Reference

WikiClientLibrary.Sites Namespace