Name |
Type |
Writable |
Restrictions |
Description |
id |
int |
|
|
The id of the Category |
parentId |
int |
V |
|
|
depth |
int |
|
|
|
partnerId |
int |
|
|
|
name |
string |
V |
|
The name of the Category.
The following characters are not allowed: '<', '>', ',' |
fullName |
string |
|
|
The full name of the Category |
fullIds |
string |
|
|
The full ids of the Category |
entriesCount |
int |
|
|
Number of entries in this Category (including child categories) |
createdAt |
int |
|
|
Creation date as Unix timestamp (In seconds) |
updatedAt |
int |
|
|
Update date as Unix timestamp (In seconds) |
description |
string |
V |
|
Category description |
tags |
string |
V |
|
Category tags |
appearInList |
KalturaAppearInListType |
V |
|
If category will be returned for list action. |
privacy |
KalturaPrivacyType |
V |
|
defines the privacy of the entries that assigned to this category |
inheritanceType |
KalturaInheritanceType |
V |
|
If Category members are inherited from parent category or set manualy. |
userJoinPolicy |
KalturaUserJoinPolicyType |
|
|
Who can ask to join this category |
defaultPermissionLevel |
KalturaCategoryUserPermissionLevel |
V |
|
Default permissionLevel for new users |
owner |
string |
V |
|
Category Owner (User id) |
directEntriesCount |
int |
|
|
Number of entries that belong to this category directly |
referenceId |
string |
V |
|
Category external id, controlled and managed by the partner. |
contributionPolicy |
KalturaContributionPolicyType |
V |
|
who can assign entries to this category |
membersCount |
int |
|
|
Number of active members for this category |
pendingMembersCount |
int |
|
|
Number of pending members for this category |
privacyContext |
string |
V |
|
Set privacy context for search entries that assiged to private and public categories. the entries will be private if the search context is set with those categories. |
privacyContexts |
string |
|
|
comma separated parents that defines a privacyContext for search |
status |
KalturaCategoryStatus |
|
|
Status |
inheritedParentId |
int |
|
|
The category id that this category inherit its members and members permission (for contribution and join) |
partnerSortValue |
int |
V |
|
Can be used to store various partner related data as a numeric value |
partnerData |
string |
V |
|
Can be used to store various partner related data as a string |
defaultOrderBy |
KalturaCategoryOrderBy |
V |
|
Enable client side applications to define how to sort the category child categories |
directSubCategoriesCount |
int |
|
|
Number of direct children categories |
moderation |
KalturaNullableBoolean |
V |
|
Moderation to add entries to this category by users that are not of permission level Manager or Moderator. |
pendingEntriesCount |
int |
|
|
Nunber of pending moderation entries |
isAggregationCategory |
KalturaNullableBoolean |
V |
|
Flag indicating that the category is an aggregation category |
aggregationCategories |
string |
V |
|
List of aggregation channels the category belongs to |