WikiHttpClient.GetPageAsync Method

Definition

Namespace:: Microsoft.TeamFoundation.Wiki.WebApi

Assembly:: Microsoft.TeamFoundation.Wiki.WebApi.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

GetPageAsync(Guid, Guid, String, Nullable<VersionControlRecursionType>, GitVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Gets metadata or content of the wiki page for the provided path. Content negotiation is done based on the `Accept` header sent in the request.
GetPageAsync(Guid, String, String, Nullable<VersionControlRecursionType>, GitVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Gets metadata or content of the wiki page for the provided path. Content negotiation is done based on the `Accept` header sent in the request.
GetPageAsync(String, Guid, String, Nullable<VersionControlRecursionType>, GitVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Gets metadata or content of the wiki page for the provided path. Content negotiation is done based on the `Accept` header sent in the request.
GetPageAsync(String, String, String, Nullable<VersionControlRecursionType>, GitVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Gets metadata or content of the wiki page for the provided path. Content negotiation is done based on the `Accept` header sent in the request.

GetPageAsync(Guid, Guid, String, Nullable<VersionControlRecursionType>, GitVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Gets metadata or content of the wiki page for the provided path. Content negotiation is done based on the Accept header sent in the request.

public System.Threading.Tasks.Task<Microsoft.TeamFoundation.Wiki.WebApi.WikiPageResponse> GetPageAsync(Guid project, Guid wikiIdentifier, string path = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor versionDescriptor = null, Nullable<bool> includeContent = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

member this.GetPageAsync : Guid * Guid * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Wiki.WebApi.WikiPageResponse>

Parameters

project: Guid

Project ID

wikiIdentifier: Guid

Wiki Id or name.

path: String

Wiki page path.

recursionLevel: Nullable<VersionControlRecursionType>

Recursion level for subpages retrieval. Defaults to None (Optional).

versionDescriptor: GitVersionDescriptor

GitVersionDescriptor for the page. Defaults to the default branch (Optional).

includeContent: Nullable<Boolean>

True to include the content of the page in the response for Json content type. Defaults to false (Optional)

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<WikiPageResponse>

Applies to

GetPageAsync(Guid, String, String, Nullable<VersionControlRecursionType>, GitVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Gets metadata or content of the wiki page for the provided path. Content negotiation is done based on the Accept header sent in the request.

public System.Threading.Tasks.Task<Microsoft.TeamFoundation.Wiki.WebApi.WikiPageResponse> GetPageAsync(Guid project, string wikiIdentifier, string path = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor versionDescriptor = null, Nullable<bool> includeContent = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

member this.GetPageAsync : Guid * string * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Wiki.WebApi.WikiPageResponse>

Parameters

project: Guid

Project ID

wikiIdentifier: String

Wiki Id or name.

path: String

Wiki page path.

recursionLevel: Nullable<VersionControlRecursionType>

Recursion level for subpages retrieval. Defaults to None (Optional).

versionDescriptor: GitVersionDescriptor

GitVersionDescriptor for the page. Defaults to the default branch (Optional).

includeContent: Nullable<Boolean>

True to include the content of the page in the response for Json content type. Defaults to false (Optional)

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<WikiPageResponse>

Applies to

GetPageAsync(String, Guid, String, Nullable<VersionControlRecursionType>, GitVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Gets metadata or content of the wiki page for the provided path. Content negotiation is done based on the Accept header sent in the request.

public System.Threading.Tasks.Task<Microsoft.TeamFoundation.Wiki.WebApi.WikiPageResponse> GetPageAsync(string project, Guid wikiIdentifier, string path = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor versionDescriptor = null, Nullable<bool> includeContent = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

member this.GetPageAsync : string * Guid * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Wiki.WebApi.WikiPageResponse>

Parameters

project: String

Project ID or project name

wikiIdentifier: Guid

Wiki Id or name.

path: String

Wiki page path.

recursionLevel: Nullable<VersionControlRecursionType>

Recursion level for subpages retrieval. Defaults to None (Optional).

versionDescriptor: GitVersionDescriptor

GitVersionDescriptor for the page. Defaults to the default branch (Optional).

includeContent: Nullable<Boolean>

True to include the content of the page in the response for Json content type. Defaults to false (Optional)

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<WikiPageResponse>

Applies to

GetPageAsync(String, String, String, Nullable<VersionControlRecursionType>, GitVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Gets metadata or content of the wiki page for the provided path. Content negotiation is done based on the Accept header sent in the request.

public System.Threading.Tasks.Task<Microsoft.TeamFoundation.Wiki.WebApi.WikiPageResponse> GetPageAsync(string project, string wikiIdentifier, string path = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor versionDescriptor = null, Nullable<bool> includeContent = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

member this.GetPageAsync : string * string * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Wiki.WebApi.WikiPageResponse>

Parameters

project: String

Project ID or project name

wikiIdentifier: String

Wiki Id or name.

path: String

Wiki page path.

recursionLevel: Nullable<VersionControlRecursionType>

Recursion level for subpages retrieval. Defaults to None (Optional).

versionDescriptor: GitVersionDescriptor

GitVersionDescriptor for the page. Defaults to the default branch (Optional).

includeContent: Nullable<Boolean>

True to include the content of the page in the response for Json content type. Defaults to false (Optional)

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<WikiPageResponse>

Applies to

Feedback

Was this page helpful?