Skip to the content.

Rakuten RMS WEB API client for .NET

< クラス一覧


CategoryIdTree

Namespace: Rakuten.RMS.Api.CategoryAPI20

CategorySet の Tree 全体を保持するオブジェクト。 Categoryの詳細情報を含まない ID だけの階層構造を保持。 UpdateCategoryTree メソッドのパラメーターとして使用。 GetCategoryTree()で取得した CategoryTree はカテゴリとその詳細情報を含む階層構造で、 CategoryTree.ToCategoryIdTree() で CategoryIdTree オブジェクトを取得し、 Tree内に存在するCateogryの操作(追加、削除、別ノードへの移動など)を行ったのち UpdateCategoryTree() で更新することが可能。

public class CategoryIdTree : System.Collections.Generic.List`1[[Rakuten.RMS.Api.CategoryAPI20.CategoryIdWithChildren, Rakuten.RMS.Api, Version=2.0.1.0, Culture=neutral, PublicKeyToken=null]], System.Collections.Generic.IList`1[[Rakuten.RMS.Api.CategoryAPI20.CategoryIdWithChildren, Rakuten.RMS.Api, Version=2.0.1.0, Culture=neutral, PublicKeyToken=null]], System.Collections.Generic.ICollection`1[[Rakuten.RMS.Api.CategoryAPI20.CategoryIdWithChildren, Rakuten.RMS.Api, Version=2.0.1.0, Culture=neutral, PublicKeyToken=null]], System.Collections.Generic.IEnumerable`1[[Rakuten.RMS.Api.CategoryAPI20.CategoryIdWithChildren, Rakuten.RMS.Api, Version=2.0.1.0, Culture=neutral, PublicKeyToken=null]], System.Collections.IEnumerable, System.Collections.IList, System.Collections.ICollection, System.Collections.Generic.IReadOnlyList`1[[Rakuten.RMS.Api.CategoryAPI20.CategoryIdWithChildren, Rakuten.RMS.Api, Version=2.0.1.0, Culture=neutral, PublicKeyToken=null]], System.Collections.Generic.IReadOnlyCollection`1[[Rakuten.RMS.Api.CategoryAPI20.CategoryIdWithChildren, Rakuten.RMS.Api, Version=2.0.1.0, Culture=neutral, PublicKeyToken=null]]

Inheritance ObjectList<CategoryIdWithChildren>CategoryIdTree
Implements IList<CategoryIdWithChildren>, ICollection<CategoryIdWithChildren>, IEnumerable<CategoryIdWithChildren>, IEnumerable, IList, ICollection, IReadOnlyList<CategoryIdWithChildren>, IReadOnlyCollection<CategoryIdWithChildren>

Properties

Capacity

public int Capacity { get; set; }

Property Value

Int32

Count

public int Count { get; }

Property Value

Int32

Item

public CategoryIdWithChildren Item { get; set; }

Property Value

CategoryIdWithChildren

Constructors

CategoryIdTree()

public CategoryIdTree()

Methods

Add(String)

public void Add(string categoryId)

Parameters

categoryId String

Find(String)

カテゴリーツリーから再帰的に目的のカテゴリーIDを検索見つけます。

public CategoryIdWithChildren Find(string categoryId)

Parameters

categoryId String

Returns

CategoryIdWithChildren

Remove(String)

カテゴリツリーから指定したカテゴリIDを削除。 該当のカテゴリは階層構造を再帰的に検索される。

public CategoryIdWithChildren Remove(string categoryId)

Parameters

categoryId String
削除対象のカテゴリID

Returns

削除されたカテゴリ(ツリー上のノード)このオブジェクトを同じツリーの別ノードに Add することが可能。

Exceptions

IndexOutOfRangeException

Remove(IList<String>)

カテゴリツリーから指定したカテゴリIDを複数一度に削除。 該当のカテゴリは階層構造を再帰的に検索される。

public IList<CategoryIdWithChildren> Remove(IList<String> categoryIds)

Parameters

categoryIds IList<String>

Returns

IList<CategoryIdWithChildren>


< クラス一覧