Class HomeClient

Namespace: GuildWars2.Pve.Home

Assembly: GW2SDK.dll

Provides query methods for home instances and homesteads.

public sealed class HomeClient

Inheritance: object

HomeClient

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

HomeClient(HttpClient): Initializes a new instance of the HomeClient class.

Methods

GetCatById(int, MissingMemberBehavior, CancellationToken): Retrieves a home cat by its ID.

GetCats(MissingMemberBehavior, CancellationToken): Retrieves all home cats.

GetCatsByIds(IEnumerable<int>, MissingMemberBehavior, CancellationToken): Retrieves home cats by their IDs.

GetCatsByPage(int, int?, MissingMemberBehavior, CancellationToken): Retrieves a page of home cats.

GetCatsIndex(CancellationToken): Retrieves the IDs of all home cats.

GetDecorationById(int, Language?, MissingMemberBehavior, CancellationToken): Retrieves a homestead decoration by its ID.

GetDecorationCategories(Language?, MissingMemberBehavior, CancellationToken): Retrieves all homestead decoration categories.

GetDecorationCategoriesByIds(IEnumerable<int>, Language?, MissingMemberBehavior, CancellationToken): Retrieves homestead decoration categories by their IDs.

GetDecorationCategoriesByPage(int, int?, Language?, MissingMemberBehavior, CancellationToken): Retrieves a page of homestead decoration categories.

GetDecorationCategoriesIndex(CancellationToken): Retrieves the IDs of all homestead decoration categories.

GetDecorationCategoryById(int, Language?, MissingMemberBehavior, CancellationToken): Retrieves a homestead decoration category by its ID.

GetDecorationsBulk(Language?, MissingMemberBehavior, int, int, IProgress<BulkProgress>?, CancellationToken): Retrieves all homestead decorations by chunking requests and executing them in parallel.

GetDecorationsBulk(IEnumerable<int>, Language?, MissingMemberBehavior, int, int, IProgress<BulkProgress>?, CancellationToken): Retrieves homestead decorations by their IDs by chunking requests and executing them in parallel. Supports more than 200 IDs.

GetDecorationsByIds(IEnumerable<int>, Language?, MissingMemberBehavior, CancellationToken): Retrieves homestead decorations by their IDs.

GetDecorationsByPage(int, int?, Language?, MissingMemberBehavior, CancellationToken): Retrieves a page of homestead decorations.

GetDecorationsIndex(CancellationToken): Retrieves the IDs of all homemestead decorations.

GetEquippedGlyphs(string?, CancellationToken): Retrieves the IDs of homestead glyphs equipped on the account associated with the access token. This endpoint is only accessible with a valid access token.

GetGlyphById(string, MissingMemberBehavior, CancellationToken): Retrieves a homestead glyph by its ID.

GetGlyphs(MissingMemberBehavior, CancellationToken): Retrieves all homestead glyphs.

GetGlyphsByIds(IEnumerable<string>, MissingMemberBehavior, CancellationToken): Retrieves homestead glyphs by their IDs.

GetGlyphsByPage(int, int?, MissingMemberBehavior, CancellationToken): Retrieves a page of homestead glyphs.

GetGlyphsIndex(CancellationToken): Retrieves the IDs of all homestead glyphs.

GetNodeById(string, MissingMemberBehavior, CancellationToken): Retrieves a home gathering node by its ID.

GetNodes(MissingMemberBehavior, CancellationToken): Retrieves all home gathering nodes.

GetNodesByIds(IEnumerable<string>, MissingMemberBehavior, CancellationToken): Retrieves home gathering nodes by their IDs.

GetNodesByPage(int, int?, MissingMemberBehavior, CancellationToken): Retrieves a page of home gathering nodes.

GetNodesIndex(CancellationToken): Retrieves the IDs of all home gathering nodes.

GetUnlockedCats(string?, CancellationToken): Retrieves the IDs of home cats unlocked on the account associated with the access token. This endpoint is only accessible with a valid access token.

GetUnlockedDecorations(string?, CancellationToken): Retrieves the homestead decorations unlocked on the account associated with the access token. This endpoint is only accessible with a valid access token.

GetUnlockedNodes(string?, CancellationToken): Retrieves the IDs of home gathering nodes unlocked on the account associated with the access token. This endpoint is only accessible with a valid access token.

Edit this page