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.



2686
2687
2688
 
# File 'lib/kaltura_types.rb', line 2686

def admin_tags
  @admin_tags
end

#aggregation_categories ⇒ Object

List of aggregation channels the category belongs to



2685
2686
2687
 
# File 'lib/kaltura_types.rb', line 2685

def aggregation_categories
  @aggregation_categories
end

#appear_in_list ⇒ Object

If category will be returned for list action.



2641
2642
2643
 
# File 'lib/kaltura_types.rb', line 2641

def appear_in_list
  @appear_in_list
end

#contribution_policy ⇒ Object

who can assign entries to this category



2657
2658
2659
 
# File 'lib/kaltura_types.rb', line 2657

def contribution_policy
  @contribution_policy
end

#created_at ⇒ Object

Creation date as Unix timestamp (In seconds)



2633
2634
2635
 
# File 'lib/kaltura_types.rb', line 2633

def created_at
  @created_at
end

#default_order_by ⇒ Object

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



2675
2676
2677
 
# File 'lib/kaltura_types.rb', line 2675

def default_order_by
  @default_order_by
end

#default_permission_level ⇒ Object

Default permissionLevel for new users



2649
2650
2651
 
# File 'lib/kaltura_types.rb', line 2649

def default_permission_level
  @default_permission_level
end

#depth ⇒ Object

Returns the value of attribute depth.



2621
2622
2623
 
# File 'lib/kaltura_types.rb', line 2621

def depth
  @depth
end

#description ⇒ Object

Category description



2637
2638
2639
 
# File 'lib/kaltura_types.rb', line 2637

def description
  @description
end

#direct_entries_count ⇒ Object

Number of entries that belong to this category directly



2653
2654
2655
 
# File 'lib/kaltura_types.rb', line 2653

def direct_entries_count
  @direct_entries_count
end

#direct_sub_categories_count ⇒ Object

Number of direct children categories



2677
2678
2679
 
# File 'lib/kaltura_types.rb', line 2677

def direct_sub_categories_count
  @direct_sub_categories_count
end

#entries_count ⇒ Object

Number of entries in this Category (including child categories)



2631
2632
2633
 
# File 'lib/kaltura_types.rb', line 2631

def entries_count
  @entries_count
end

#full_ids ⇒ Object

The full ids of the Category



2629
2630
2631
 
# File 'lib/kaltura_types.rb', line 2629

def full_ids
  @full_ids
end

#full_name ⇒ Object

The full name of the Category



2627
2628
2629
 
# File 'lib/kaltura_types.rb', line 2627

def full_name
  @full_name
end

#id ⇒ Object

The id of the Category



2619
2620
2621
 
# File 'lib/kaltura_types.rb', line 2619

def id
  @id
end

#inheritance_type ⇒ Object

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



2645
2646
2647
 
# File 'lib/kaltura_types.rb', line 2645

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)



2669
2670
2671
 
# File 'lib/kaltura_types.rb', line 2669

def inherited_parent_id
  @inherited_parent_id
end

#is_aggregation_category ⇒ Object

Flag indicating that the category is an aggregation category



2683
2684
2685
 
# File 'lib/kaltura_types.rb', line 2683

def is_aggregation_category
  @is_aggregation_category
end

#members_count ⇒ Object

Number of active members for this category



2659
2660
2661
 
# File 'lib/kaltura_types.rb', line 2659

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.



2679
2680
2681
 
# File 'lib/kaltura_types.rb', line 2679

def moderation
  @moderation
end

#name ⇒ Object

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



2625
2626
2627
 
# File 'lib/kaltura_types.rb', line 2625

def name
  @name
end

#owner ⇒ Object

Category Owner (User id)



2651
2652
2653
 
# File 'lib/kaltura_types.rb', line 2651

def owner
  @owner
end

#parent_id ⇒ Object

Returns the value of attribute parent_id.



2620
2621
2622
 
# File 'lib/kaltura_types.rb', line 2620

def parent_id
  @parent_id
end

#partner_data ⇒ Object

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



2673
2674
2675
 
# File 'lib/kaltura_types.rb', line 2673

def partner_data
  @partner_data
end

#partner_id ⇒ Object

Returns the value of attribute partner_id.



2622
2623
2624
 
# File 'lib/kaltura_types.rb', line 2622

def partner_id
  @partner_id
end

#partner_sort_value ⇒ Object

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



2671
2672
2673
 
# File 'lib/kaltura_types.rb', line 2671

def partner_sort_value
  @partner_sort_value
end

#pending_entries_count ⇒ Object

Nunber of pending moderation entries



2681
2682
2683
 
# File 'lib/kaltura_types.rb', line 2681

def pending_entries_count
  @pending_entries_count
end

#pending_members_count ⇒ Object

Number of pending members for this category



2661
2662
2663
 
# File 'lib/kaltura_types.rb', line 2661

def pending_members_count
  @pending_members_count
end

#privacy ⇒ Object

defines the privacy of the entries that assigned to this category



2643
2644
2645
 
# File 'lib/kaltura_types.rb', line 2643

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.



2663
2664
2665
 
# File 'lib/kaltura_types.rb', line 2663

def privacy_context
  @privacy_context
end

#privacy_contexts ⇒ Object

comma separated parents that defines a privacyContext for search



2665
2666
2667
 
# File 'lib/kaltura_types.rb', line 2665

def privacy_contexts
  @privacy_contexts
end

#reference_id ⇒ Object

Category external id, controlled and managed by the partner.



2655
2656
2657
 
# File 'lib/kaltura_types.rb', line 2655

def reference_id
  @reference_id
end

#status ⇒ Object

Status



2667
2668
2669
 
# File 'lib/kaltura_types.rb', line 2667

def status
  @status
end

#tags ⇒ Object

Category tags



2639
2640
2641
 
# File 'lib/kaltura_types.rb', line 2639

def tags
  @tags
end

#updated_at ⇒ Object

Update date as Unix timestamp (In seconds)



2635
2636
2637
 
# File 'lib/kaltura_types.rb', line 2635

def updated_at
  @updated_at
end

#user_join_policy ⇒ Object

Who can ask to join this category



2647
2648
2649
 
# File 'lib/kaltura_types.rb', line 2647

def user_join_policy
  @user_join_policy
end

Instance Method Details

#from_xml(xml_element) ⇒ Object 



2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
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
 
# 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