class Kaltura::KalturaCategory

Attributes

admin_tags[RW]
aggregation_categories[RW]

List of aggregation channels the category belongs to

appear_in_list[RW]

If category will be returned for list action.

contribution_policy[RW]

who can assign entries to this category

created_at[RW]

Creation date as Unix timestamp (In seconds)

default_order_by[RW]

Enable client side applications to define how to sort the category child categories

default_permission_level[RW]

Default permissionLevel for new users

depth[RW]
description[RW]

Category description

direct_entries_count[RW]

Number of entries that belong to this category directly

direct_sub_categories_count[RW]

Number of direct children categories

entries_count[RW]

Number of entries in this Category (including child categories)

full_ids[RW]

The full ids of the Category

full_name[RW]

The full name of the Category

id[RW]

The id of the Category

inheritance_type[RW]

If Category members are inherited from parent category or set manualy.

inherited_parent_id[RW]

The category id that this category inherit its members and members permission (for contribution and join)

is_aggregation_category[RW]

Flag indicating that the category is an aggregation category

members_count[RW]

Number of active members for this category

moderation[RW]

Moderation to add entries to this category by users that are not of permission level Manager or Moderator.

name[RW]

The name of the Category.

The following characters are not allowed: '<', '>', ','
owner[RW]

Category Owner (User id)

parent_id[RW]
partner_data[RW]

Can be used to store various partner related data as a string

partner_id[RW]
partner_sort_value[RW]

Can be used to store various partner related data as a numeric value

pending_entries_count[RW]

Nunber of pending moderation entries

pending_members_count[RW]

Number of pending members for this category

privacy[RW]

defines the privacy of the entries that assigned to this category

privacy_context[RW]

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.

privacy_contexts[RW]

comma separated parents that defines a privacyContext for search

reference_id[RW]

Category external id, controlled and managed by the partner.

status[RW]

Status

tags[RW]

Category tags

updated_at[RW]

Update date as Unix timestamp (In seconds)

user_join_policy[RW]

Who can ask to join this category

Public Instance Methods

appear_in_list=(val) click to toggle source
# File lib/kaltura_types.rb, line 2709
def appear_in_list=(val)
        @appear_in_list = val.to_i
end
contribution_policy=(val) click to toggle source
# File lib/kaltura_types.rb, line 2727
def contribution_policy=(val)
        @contribution_policy = val.to_i
end
created_at=(val) click to toggle source
# File lib/kaltura_types.rb, line 2703
def created_at=(val)
        @created_at = val.to_i
end
default_permission_level=(val) click to toggle source
# File lib/kaltura_types.rb, line 2721
def default_permission_level=(val)
        @default_permission_level = val.to_i
end
depth=(val) click to toggle source
# File lib/kaltura_types.rb, line 2694
def depth=(val)
        @depth = val.to_i
end
direct_entries_count=(val) click to toggle source
# File lib/kaltura_types.rb, line 2724
def direct_entries_count=(val)
        @direct_entries_count = val.to_i
end
direct_sub_categories_count=(val) click to toggle source
# File lib/kaltura_types.rb, line 2745
def direct_sub_categories_count=(val)
        @direct_sub_categories_count = val.to_i
end
entries_count=(val) click to toggle source
# File lib/kaltura_types.rb, line 2700
def entries_count=(val)
        @entries_count = val.to_i
end
from_xml(xml_element) click to toggle source
Calls superclass method Kaltura::KalturaObjectBase#from_xml
# File lib/kaltura_types.rb, line 2758
def from_xml(xml_element)
        super
        if xml_element.elements['id'] != nil
                self.id = xml_element.elements['id'].text
        end
        if xml_element.elements['parentId'] != nil
                self.parent_id = xml_element.elements['parentId'].text
        end
        if xml_element.elements['depth'] != nil
                self.depth = xml_element.elements['depth'].text
        end
        if xml_element.elements['partnerId'] != nil
                self.partner_id = xml_element.elements['partnerId'].text
        end
        if xml_element.elements['name'] != nil
                self.name = xml_element.elements['name'].text
        end
        if xml_element.elements['fullName'] != nil
                self.full_name = xml_element.elements['fullName'].text
        end
        if xml_element.elements['fullIds'] != nil
                self.full_ids = xml_element.elements['fullIds'].text
        end
        if xml_element.elements['entriesCount'] != nil
                self.entries_count = xml_element.elements['entriesCount'].text
        end
        if xml_element.elements['createdAt'] != nil
                self.created_at = xml_element.elements['createdAt'].text
        end
        if xml_element.elements['updatedAt'] != nil
                self.updated_at = xml_element.elements['updatedAt'].text
        end
        if xml_element.elements['description'] != nil
                self.description = xml_element.elements['description'].text
        end
        if xml_element.elements['tags'] != nil
                self.tags = xml_element.elements['tags'].text
        end
        if xml_element.elements['appearInList'] != nil
                self.appear_in_list = xml_element.elements['appearInList'].text
        end
        if xml_element.elements['privacy'] != nil
                self.privacy = xml_element.elements['privacy'].text
        end
        if xml_element.elements['inheritanceType'] != nil
                self.inheritance_type = xml_element.elements['inheritanceType'].text
        end
        if xml_element.elements['userJoinPolicy'] != nil
                self.user_join_policy = xml_element.elements['userJoinPolicy'].text
        end
        if xml_element.elements['defaultPermissionLevel'] != nil
                self.default_permission_level = xml_element.elements['defaultPermissionLevel'].text
        end
        if xml_element.elements['owner'] != nil
                self.owner = xml_element.elements['owner'].text
        end
        if xml_element.elements['directEntriesCount'] != nil
                self.direct_entries_count = xml_element.elements['directEntriesCount'].text
        end
        if xml_element.elements['referenceId'] != nil
                self.reference_id = xml_element.elements['referenceId'].text
        end
        if xml_element.elements['contributionPolicy'] != nil
                self.contribution_policy = xml_element.elements['contributionPolicy'].text
        end
        if xml_element.elements['membersCount'] != nil
                self.members_count = xml_element.elements['membersCount'].text
        end
        if xml_element.elements['pendingMembersCount'] != nil
                self.pending_members_count = xml_element.elements['pendingMembersCount'].text
        end
        if xml_element.elements['privacyContext'] != nil
                self.privacy_context = xml_element.elements['privacyContext'].text
        end
        if xml_element.elements['privacyContexts'] != nil
                self.privacy_contexts = xml_element.elements['privacyContexts'].text
        end
        if xml_element.elements['status'] != nil
                self.status = xml_element.elements['status'].text
        end
        if xml_element.elements['inheritedParentId'] != nil
                self.inherited_parent_id = xml_element.elements['inheritedParentId'].text
        end
        if xml_element.elements['partnerSortValue'] != nil
                self.partner_sort_value = xml_element.elements['partnerSortValue'].text
        end
        if xml_element.elements['partnerData'] != nil
                self.partner_data = xml_element.elements['partnerData'].text
        end
        if xml_element.elements['defaultOrderBy'] != nil
                self.default_order_by = xml_element.elements['defaultOrderBy'].text
        end
        if xml_element.elements['directSubCategoriesCount'] != nil
                self.direct_sub_categories_count = xml_element.elements['directSubCategoriesCount'].text
        end
        if xml_element.elements['moderation'] != nil
                self.moderation = xml_element.elements['moderation'].text
        end
        if xml_element.elements['pendingEntriesCount'] != nil
                self.pending_entries_count = xml_element.elements['pendingEntriesCount'].text
        end
        if xml_element.elements['isAggregationCategory'] != nil
                self.is_aggregation_category = xml_element.elements['isAggregationCategory'].text
        end
        if xml_element.elements['aggregationCategories'] != nil
                self.aggregation_categories = xml_element.elements['aggregationCategories'].text
        end
        if xml_element.elements['adminTags'] != nil
                self.admin_tags = xml_element.elements['adminTags'].text
        end
end
id=(val) click to toggle source
# File lib/kaltura_types.rb, line 2688
def id=(val)
        @id = val.to_i
end
inheritance_type=(val) click to toggle source
# File lib/kaltura_types.rb, line 2715
def inheritance_type=(val)
        @inheritance_type = val.to_i
end
inherited_parent_id=(val) click to toggle source
# File lib/kaltura_types.rb, line 2739
def inherited_parent_id=(val)
        @inherited_parent_id = val.to_i
end
is_aggregation_category=(val) click to toggle source
# File lib/kaltura_types.rb, line 2754
def is_aggregation_category=(val)
        @is_aggregation_category = val.to_i
end
members_count=(val) click to toggle source
# File lib/kaltura_types.rb, line 2730
def members_count=(val)
        @members_count = val.to_i
end
moderation=(val) click to toggle source
# File lib/kaltura_types.rb, line 2748
def moderation=(val)
        @moderation = val.to_i
end
parent_id=(val) click to toggle source
# File lib/kaltura_types.rb, line 2691
def parent_id=(val)
        @parent_id = val.to_i
end
partner_id=(val) click to toggle source
# File lib/kaltura_types.rb, line 2697
def partner_id=(val)
        @partner_id = val.to_i
end
partner_sort_value=(val) click to toggle source
# File lib/kaltura_types.rb, line 2742
def partner_sort_value=(val)
        @partner_sort_value = val.to_i
end
pending_entries_count=(val) click to toggle source
# File lib/kaltura_types.rb, line 2751
def pending_entries_count=(val)
        @pending_entries_count = val.to_i
end
pending_members_count=(val) click to toggle source
# File lib/kaltura_types.rb, line 2733
def pending_members_count=(val)
        @pending_members_count = val.to_i
end
privacy=(val) click to toggle source
# File lib/kaltura_types.rb, line 2712
def privacy=(val)
        @privacy = val.to_i
end
status=(val) click to toggle source
# File lib/kaltura_types.rb, line 2736
def status=(val)
        @status = val.to_i
end
updated_at=(val) click to toggle source
# File lib/kaltura_types.rb, line 2706
def updated_at=(val)
        @updated_at = val.to_i
end
user_join_policy=(val) click to toggle source
# File lib/kaltura_types.rb, line 2718
def user_join_policy=(val)
        @user_join_policy = val.to_i
end