WikiFamilyGetSiteAsync Method

This is preliminary documentation and is subject to change.

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.

Namespace: WikiClientLibrary.Sites
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.9.0-int.3+0a73c45f0c78941900e328c6c6b819597b665e00

Syntax

C++

Copy

public Task<WikiSite?> GetSiteAsync(
	string prefix
)

Public Function GetSiteAsync ( 
	prefix As String
) As Task(Of WikiSite)

Dim instance As WikiFamily
Dim prefix As String

Dim returnValue As Task(Of WikiSite)

returnValue = instance.GetSiteAsync(prefix)

public:
virtual Task<WikiSite^>^ GetSiteAsync(
	String^ prefix
) sealed

abstract GetSiteAsync : 
        prefix : string -> Task<WikiSite> 
override GetSiteAsync : 
        prefix : string -> Task<WikiSite>

Parameters

prefix String: The member name in the family. Usually this is the interwiki prefix.

Return Value

TaskWikiSite
A site instance, or null if no site with the specified family name found..

Implements

IWikiFamilyGetSiteAsync(String)

Exceptions

Exception	Condition
ArgumentNullException	prefix is null.

Remarks

The implementation should be thread-safe, if multiple threads are to use this instance with other classes.

Reference

WikiFamily Class

WikiClientLibrary.Sites Namespace