Interface CategoryAPI

Category API methods

See

Category API Docs

interface CategoryAPI {
    create(category: Category.CreateRequest): Promise<CreateResponse>;
    delete(categoryId: string): Promise<void>;
    details(categoryId: string): Promise<Category.Details>;
    list(
        parentCategoryId?: string,
        includeAllDescendants?: boolean,
    ): Promise<Category[]>;
    listAssignable(): Promise<Assignable[]>;
    update(categoryId: string, category: EditRequest): Promise<void>;
}

Hierarchy

API
- CategoryAPI

Index

Methods

create delete details list listAssignable update

Methods

create

create(category: Category.CreateRequest): Promise<CreateResponse>
Parameters
- category: Category.CreateRequest
Returns Promise<CreateResponse>
Inherited from API.create
- Defined in src/api/category.ts:17

delete

delete(categoryId: string): Promise<void>
Parameters
- categoryId: string
Returns Promise<void>
Inherited from API.delete
- Defined in src/api/category.ts:26

details

details(categoryId: string): Promise<Category.Details>
Parameters
- categoryId: string
Returns Promise<Category.Details>
Inherited from API.details
- Defined in src/api/category.ts:20

list

list(
parentCategoryId?: string,
includeAllDescendants?: boolean,
): Promise<Category[]>
get list of categories in system
Parameters
- OptionalparentCategoryId: string
- OptionalincludeAllDescendants: boolean
Returns Promise<Category[]>
See
https://revdocs.vbrick.com/reference#getcategories
Inherited from API.list
- Defined in src/api/category.ts:33

listAssignable

listAssignable(): Promise<Assignable[]>
get list of categories that current user has ability to add videos to

Returns Promise<Assignable[]>
Inherited from API.listAssignable
- Defined in src/api/category.ts:46

update

update(categoryId: string, category: EditRequest): Promise<void>
Parameters
- categoryId: string
- category: EditRequest
Returns Promise<void>
Inherited from API.update
- Defined in src/api/category.ts:23