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



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

def aggregation_categories
  @aggregation_categories
end

#appear_in_list ⇒ Object

If category will be returned for list action.



2518
2519
2520
 
# File 'lib/kaltura_types.rb', line 2518

def appear_in_list
  @appear_in_list
end

#contribution_policy ⇒ Object

who can assign entries to this category



2534
2535
2536
 
# File 'lib/kaltura_types.rb', line 2534

def contribution_policy
  @contribution_policy
end

#created_at ⇒ Object

Creation date as Unix timestamp (In seconds)



2510
2511
2512
 
# File 'lib/kaltura_types.rb', line 2510

def created_at
  @created_at
end

#default_order_by ⇒ Object

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



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

def default_order_by
  @default_order_by
end

#default_permission_level ⇒ Object

Default permissionLevel for new users



2526
2527
2528
 
# File 'lib/kaltura_types.rb', line 2526

def default_permission_level
  @default_permission_level
end

#depth ⇒ Object

Returns the value of attribute depth.



2498
2499
2500
 
# File 'lib/kaltura_types.rb', line 2498

def depth
  @depth
end

#description ⇒ Object

Category description



2514
2515
2516
 
# File 'lib/kaltura_types.rb', line 2514

def description
  @description
end

#direct_entries_count ⇒ Object

Number of entries that belong to this category directly



2530
2531
2532
 
# File 'lib/kaltura_types.rb', line 2530

def direct_entries_count
  @direct_entries_count
end

#direct_sub_categories_count ⇒ Object

Number of direct children categories



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

def direct_sub_categories_count
  @direct_sub_categories_count
end

#entries_count ⇒ Object

Number of entries in this Category (including child categories)



2508
2509
2510
 
# File 'lib/kaltura_types.rb', line 2508

def entries_count
  @entries_count
end

#full_ids ⇒ Object

The full ids of the Category



2506
2507
2508
 
# File 'lib/kaltura_types.rb', line 2506

def full_ids
  @full_ids
end

#full_name ⇒ Object

The full name of the Category



2504
2505
2506
 
# File 'lib/kaltura_types.rb', line 2504

def full_name
  @full_name
end

#id ⇒ Object

The id of the Category



2496
2497
2498
 
# File 'lib/kaltura_types.rb', line 2496

def id
  @id
end

#inheritance_type ⇒ Object

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



2522
2523
2524
 
# File 'lib/kaltura_types.rb', line 2522

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)



2546
2547
2548
 
# File 'lib/kaltura_types.rb', line 2546

def inherited_parent_id
  @inherited_parent_id
end

#is_aggregation_category ⇒ Object

Flag indicating that the category is an aggregation category



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

def is_aggregation_category
  @is_aggregation_category
end

#members_count ⇒ Object

Number of active members for this category



2536
2537
2538
 
# File 'lib/kaltura_types.rb', line 2536

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.



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

def moderation
  @moderation
end

#name ⇒ Object

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



2502
2503
2504
 
# File 'lib/kaltura_types.rb', line 2502

def name
  @name
end

#owner ⇒ Object

Category Owner (User id)



2528
2529
2530
 
# File 'lib/kaltura_types.rb', line 2528

def owner
  @owner
end

#parent_id ⇒ Object

Returns the value of attribute parent_id.



2497
2498
2499
 
# File 'lib/kaltura_types.rb', line 2497

def parent_id
  @parent_id
end

#partner_data ⇒ Object

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



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

def partner_data
  @partner_data
end

#partner_id ⇒ Object

Returns the value of attribute partner_id.



2499
2500
2501
 
# File 'lib/kaltura_types.rb', line 2499

def partner_id
  @partner_id
end

#partner_sort_value ⇒ Object

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



2548
2549
2550
 
# File 'lib/kaltura_types.rb', line 2548

def partner_sort_value
  @partner_sort_value
end

#pending_entries_count ⇒ Object

Nunber of pending moderation entries



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

def pending_entries_count
  @pending_entries_count
end

#pending_members_count ⇒ Object

Number of pending members for this category



2538
2539
2540
 
# File 'lib/kaltura_types.rb', line 2538

def pending_members_count
  @pending_members_count
end

#privacy ⇒ Object

defines the privacy of the entries that assigned to this category



2520
2521
2522
 
# File 'lib/kaltura_types.rb', line 2520

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.



2540
2541
2542
 
# File 'lib/kaltura_types.rb', line 2540

def privacy_context
  @privacy_context
end

#privacy_contexts ⇒ Object

comma separated parents that defines a privacyContext for search



2542
2543
2544
 
# File 'lib/kaltura_types.rb', line 2542

def privacy_contexts
  @privacy_contexts
end

#reference_id ⇒ Object

Category external id, controlled and managed by the partner.



2532
2533
2534
 
# File 'lib/kaltura_types.rb', line 2532

def reference_id
  @reference_id
end

#status ⇒ Object

Status



2544
2545
2546
 
# File 'lib/kaltura_types.rb', line 2544

def status
  @status
end

#tags ⇒ Object

Category tags



2516
2517
2518
 
# File 'lib/kaltura_types.rb', line 2516

def tags
  @tags
end

#updated_at ⇒ Object

Update date as Unix timestamp (In seconds)



2512
2513
2514
 
# File 'lib/kaltura_types.rb', line 2512

def updated_at
  @updated_at
end

#user_join_policy ⇒ Object

Who can ask to join this category



2524
2525
2526
 
# File 'lib/kaltura_types.rb', line 2524

def user_join_policy
  @user_join_policy
end

Instance Method Details

#from_xml(xml_element) ⇒ Object 



2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
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
 
# File 'lib/kaltura_types.rb', line 2634

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