Class: Kaltura::KalturaCategory

Inherits:
KalturaObjectBase show all
Defined in:
lib/kaltura_types.rb

Instance Attribute Summary collapse

Attributes inherited from KalturaObjectBase

#object_type, #related_objects

Instance Method Summary collapse

Methods inherited from KalturaObjectBase

#camelcase, #to_b, #to_params

Instance Attribute Details

#admin_tags ⇒ Object

Returns the value of attribute admin_tags.



2760
2761
2762
 
# File 'lib/kaltura_types.rb', line 2760

def admin_tags
  @admin_tags
end

#aggregation_categories ⇒ Object

List of aggregation channels the category belongs to



2759
2760
2761
 
# File 'lib/kaltura_types.rb', line 2759

def aggregation_categories
  @aggregation_categories
end

#appear_in_list ⇒ Object

If category will be returned for list action.



2715
2716
2717
 
# File 'lib/kaltura_types.rb', line 2715

def appear_in_list
  @appear_in_list
end

#contribution_policy ⇒ Object

who can assign entries to this category



2731
2732
2733
 
# File 'lib/kaltura_types.rb', line 2731

def contribution_policy
  @contribution_policy
end

#created_at ⇒ Object

Creation date as Unix timestamp (In seconds)



2707
2708
2709
 
# File 'lib/kaltura_types.rb', line 2707

def created_at
  @created_at
end

#default_order_by ⇒ Object

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



2749
2750
2751
 
# File 'lib/kaltura_types.rb', line 2749

def default_order_by
  @default_order_by
end

#default_permission_level ⇒ Object

Default permissionLevel for new users



2723
2724
2725
 
# File 'lib/kaltura_types.rb', line 2723

def default_permission_level
  @default_permission_level
end

#depth ⇒ Object

Returns the value of attribute depth.



2695
2696
2697
 
# File 'lib/kaltura_types.rb', line 2695

def depth
  @depth
end

#description ⇒ Object

Category description



2711
2712
2713
 
# File 'lib/kaltura_types.rb', line 2711

def description
  @description
end

#direct_entries_count ⇒ Object

Number of entries that belong to this category directly



2727
2728
2729
 
# File 'lib/kaltura_types.rb', line 2727

def direct_entries_count
  @direct_entries_count
end

#direct_sub_categories_count ⇒ Object

Number of direct children categories



2751
2752
2753
 
# File 'lib/kaltura_types.rb', line 2751

def direct_sub_categories_count
  @direct_sub_categories_count
end

#entries_count ⇒ Object

Number of entries in this Category (including child categories)



2705
2706
2707
 
# File 'lib/kaltura_types.rb', line 2705

def entries_count
  @entries_count
end

#full_ids ⇒ Object

The full ids of the Category



2703
2704
2705
 
# File 'lib/kaltura_types.rb', line 2703

def full_ids
  @full_ids
end

#full_name ⇒ Object

The full name of the Category



2701
2702
2703
 
# File 'lib/kaltura_types.rb', line 2701

def full_name
  @full_name
end

#id ⇒ Object

The id of the Category



2693
2694
2695
 
# File 'lib/kaltura_types.rb', line 2693

def id
  @id
end

#inheritance_type ⇒ Object

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



2719
2720
2721
 
# File 'lib/kaltura_types.rb', line 2719

def inheritance_type
  @inheritance_type
end

#inherited_parent_id ⇒ Object

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



2743
2744
2745
 
# File 'lib/kaltura_types.rb', line 2743

def inherited_parent_id
  @inherited_parent_id
end

#is_aggregation_category ⇒ Object

Flag indicating that the category is an aggregation category



2757
2758
2759
 
# File 'lib/kaltura_types.rb', line 2757

def is_aggregation_category
  @is_aggregation_category
end

#members_count ⇒ Object

Number of active members for this category



2733
2734
2735
 
# File 'lib/kaltura_types.rb', line 2733

def members_count
  @members_count
end

#moderation ⇒ Object

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



2753
2754
2755
 
# File 'lib/kaltura_types.rb', line 2753

def moderation
  @moderation
end

#name ⇒ Object

The name of the Category. The following characters are not allowed: ‘<’, ‘>’, ‘,’



2699
2700
2701
 
# File 'lib/kaltura_types.rb', line 2699

def name
  @name
end

#owner ⇒ Object

Category Owner (User id)



2725
2726
2727
 
# File 'lib/kaltura_types.rb', line 2725

def owner
  @owner
end

#parent_id ⇒ Object

Returns the value of attribute parent_id.



2694
2695
2696
 
# File 'lib/kaltura_types.rb', line 2694

def parent_id
  @parent_id
end

#partner_data ⇒ Object

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



2747
2748
2749
 
# File 'lib/kaltura_types.rb', line 2747

def partner_data
  @partner_data
end

#partner_id ⇒ Object

Returns the value of attribute partner_id.



2696
2697
2698
 
# File 'lib/kaltura_types.rb', line 2696

def partner_id
  @partner_id
end

#partner_sort_value ⇒ Object

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



2745
2746
2747
 
# File 'lib/kaltura_types.rb', line 2745

def partner_sort_value
  @partner_sort_value
end

#pending_entries_count ⇒ Object

Nunber of pending moderation entries



2755
2756
2757
 
# File 'lib/kaltura_types.rb', line 2755

def pending_entries_count
  @pending_entries_count
end

#pending_members_count ⇒ Object

Number of pending members for this category



2735
2736
2737
 
# File 'lib/kaltura_types.rb', line 2735

def pending_members_count
  @pending_members_count
end

#privacy ⇒ Object

defines the privacy of the entries that assigned to this category



2717
2718
2719
 
# File 'lib/kaltura_types.rb', line 2717

def privacy
  @privacy
end

#privacy_context ⇒ Object

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.



2737
2738
2739
 
# File 'lib/kaltura_types.rb', line 2737

def privacy_context
  @privacy_context
end

#privacy_contexts ⇒ Object

comma separated parents that defines a privacyContext for search



2739
2740
2741
 
# File 'lib/kaltura_types.rb', line 2739

def privacy_contexts
  @privacy_contexts
end

#reference_id ⇒ Object

Category external id, controlled and managed by the partner.



2729
2730
2731
 
# File 'lib/kaltura_types.rb', line 2729

def reference_id
  @reference_id
end

#status ⇒ Object

Status



2741
2742
2743
 
# File 'lib/kaltura_types.rb', line 2741

def status
  @status
end

#tags ⇒ Object

Category tags



2713
2714
2715
 
# File 'lib/kaltura_types.rb', line 2713

def tags
  @tags
end

#updated_at ⇒ Object

Update date as Unix timestamp (In seconds)



2709
2710
2711
 
# File 'lib/kaltura_types.rb', line 2709

def updated_at
  @updated_at
end

#user_join_policy ⇒ Object

Who can ask to join this category



2721
2722
2723
 
# File 'lib/kaltura_types.rb', line 2721

def user_join_policy
  @user_join_policy
end

Instance Method Details

#from_xml(xml_element) ⇒ Object 



2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
 
# File 'lib/kaltura_types.rb', line 2832

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