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

#aggregation_categories ⇒ Object

List of aggregation channels the category belongs to



2616
2617
2618
 
# File 'lib/kaltura_types.rb', line 2616

def aggregation_categories
  @aggregation_categories
end

#appear_in_list ⇒ Object

If category will be returned for list action.



2572
2573
2574
 
# File 'lib/kaltura_types.rb', line 2572

def appear_in_list
  @appear_in_list
end

#contribution_policy ⇒ Object

who can assign entries to this category



2588
2589
2590
 
# File 'lib/kaltura_types.rb', line 2588

def contribution_policy
  @contribution_policy
end

#created_at ⇒ Object

Creation date as Unix timestamp (In seconds)



2564
2565
2566
 
# File 'lib/kaltura_types.rb', line 2564

def created_at
  @created_at
end

#default_order_by ⇒ Object

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



2606
2607
2608
 
# File 'lib/kaltura_types.rb', line 2606

def default_order_by
  @default_order_by
end

#default_permission_level ⇒ Object

Default permissionLevel for new users



2580
2581
2582
 
# File 'lib/kaltura_types.rb', line 2580

def default_permission_level
  @default_permission_level
end

#depth ⇒ Object

Returns the value of attribute depth.



2552
2553
2554
 
# File 'lib/kaltura_types.rb', line 2552

def depth
  @depth
end

#description ⇒ Object

Category description



2568
2569
2570
 
# File 'lib/kaltura_types.rb', line 2568

def description
  @description
end

#direct_entries_count ⇒ Object

Number of entries that belong to this category directly



2584
2585
2586
 
# File 'lib/kaltura_types.rb', line 2584

def direct_entries_count
  @direct_entries_count
end

#direct_sub_categories_count ⇒ Object

Number of direct children categories



2608
2609
2610
 
# File 'lib/kaltura_types.rb', line 2608

def direct_sub_categories_count
  @direct_sub_categories_count
end

#entries_count ⇒ Object

Number of entries in this Category (including child categories)



2562
2563
2564
 
# File 'lib/kaltura_types.rb', line 2562

def entries_count
  @entries_count
end

#full_ids ⇒ Object

The full ids of the Category



2560
2561
2562
 
# File 'lib/kaltura_types.rb', line 2560

def full_ids
  @full_ids
end

#full_name ⇒ Object

The full name of the Category



2558
2559
2560
 
# File 'lib/kaltura_types.rb', line 2558

def full_name
  @full_name
end

#id ⇒ Object

The id of the Category



2550
2551
2552
 
# File 'lib/kaltura_types.rb', line 2550

def id
  @id
end

#inheritance_type ⇒ Object

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



2576
2577
2578
 
# File 'lib/kaltura_types.rb', line 2576

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)



2600
2601
2602
 
# File 'lib/kaltura_types.rb', line 2600

def inherited_parent_id
  @inherited_parent_id
end

#is_aggregation_category ⇒ Object

Flag indicating that the category is an aggregation category



2614
2615
2616
 
# File 'lib/kaltura_types.rb', line 2614

def is_aggregation_category
  @is_aggregation_category
end

#members_count ⇒ Object

Number of active members for this category



2590
2591
2592
 
# File 'lib/kaltura_types.rb', line 2590

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.



2610
2611
2612
 
# File 'lib/kaltura_types.rb', line 2610

def moderation
  @moderation
end

#name ⇒ Object

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



2556
2557
2558
 
# File 'lib/kaltura_types.rb', line 2556

def name
  @name
end

#owner ⇒ Object

Category Owner (User id)



2582
2583
2584
 
# File 'lib/kaltura_types.rb', line 2582

def owner
  @owner
end

#parent_id ⇒ Object

Returns the value of attribute parent_id.



2551
2552
2553
 
# File 'lib/kaltura_types.rb', line 2551

def parent_id
  @parent_id
end

#partner_data ⇒ Object

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



2604
2605
2606
 
# File 'lib/kaltura_types.rb', line 2604

def partner_data
  @partner_data
end

#partner_id ⇒ Object

Returns the value of attribute partner_id.



2553
2554
2555
 
# File 'lib/kaltura_types.rb', line 2553

def partner_id
  @partner_id
end

#partner_sort_value ⇒ Object

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



2602
2603
2604
 
# File 'lib/kaltura_types.rb', line 2602

def partner_sort_value
  @partner_sort_value
end

#pending_entries_count ⇒ Object

Nunber of pending moderation entries



2612
2613
2614
 
# File 'lib/kaltura_types.rb', line 2612

def pending_entries_count
  @pending_entries_count
end

#pending_members_count ⇒ Object

Number of pending members for this category



2592
2593
2594
 
# File 'lib/kaltura_types.rb', line 2592

def pending_members_count
  @pending_members_count
end

#privacy ⇒ Object

defines the privacy of the entries that assigned to this category



2574
2575
2576
 
# File 'lib/kaltura_types.rb', line 2574

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.



2594
2595
2596
 
# File 'lib/kaltura_types.rb', line 2594

def privacy_context
  @privacy_context
end

#privacy_contexts ⇒ Object

comma separated parents that defines a privacyContext for search



2596
2597
2598
 
# File 'lib/kaltura_types.rb', line 2596

def privacy_contexts
  @privacy_contexts
end

#reference_id ⇒ Object

Category external id, controlled and managed by the partner.



2586
2587
2588
 
# File 'lib/kaltura_types.rb', line 2586

def reference_id
  @reference_id
end

#status ⇒ Object

Status



2598
2599
2600
 
# File 'lib/kaltura_types.rb', line 2598

def status
  @status
end

#tags ⇒ Object

Category tags



2570
2571
2572
 
# File 'lib/kaltura_types.rb', line 2570

def tags
  @tags
end

#updated_at ⇒ Object

Update date as Unix timestamp (In seconds)



2566
2567
2568
 
# File 'lib/kaltura_types.rb', line 2566

def updated_at
  @updated_at
end

#user_join_policy ⇒ Object

Who can ask to join this category



2578
2579
2580
 
# File 'lib/kaltura_types.rb', line 2578

def user_join_policy
  @user_join_policy
end

Instance Method Details

#from_xml(xml_element) ⇒ Object 



2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
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
 
# File 'lib/kaltura_types.rb', line 2688

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
end