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

#appear_in_list ⇒ Object

If category will be returned for list action.



1426
1427
1428
 
# File 'lib/kaltura_types.rb', line 1426

def appear_in_list
  @appear_in_list
end

#contribution_policy ⇒ Object

who can assign entries to this category



1450
1451
1452
 
# File 'lib/kaltura_types.rb', line 1450

def contribution_policy
  @contribution_policy
end

#created_at ⇒ Object

Creation date as Unix timestamp (In seconds)



1414
1415
1416
 
# File 'lib/kaltura_types.rb', line 1414

def created_at
  @created_at
end

#default_order_by ⇒ Object

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



1477
1478
1479
 
# File 'lib/kaltura_types.rb', line 1477

def default_order_by
  @default_order_by
end

#default_permission_level ⇒ Object

Default permissionLevel for new users



1438
1439
1440
 
# File 'lib/kaltura_types.rb', line 1438

def default_permission_level
  @default_permission_level
end

#depth ⇒ Object

Returns the value of attribute depth.



1397
1398
1399
 
# File 'lib/kaltura_types.rb', line 1397

def depth
  @depth
end

#description ⇒ Object

Category description



1420
1421
1422
 
# File 'lib/kaltura_types.rb', line 1420

def description
  @description
end

#direct_entries_count ⇒ Object

Number of entries that belong to this category directly



1444
1445
1446
 
# File 'lib/kaltura_types.rb', line 1444

def direct_entries_count
  @direct_entries_count
end

#direct_sub_categories_count ⇒ Object

Number of direct children categories



1480
1481
1482
 
# File 'lib/kaltura_types.rb', line 1480

def direct_sub_categories_count
  @direct_sub_categories_count
end

#entries_count ⇒ Object

Number of entries in this Category (including child categories)



1411
1412
1413
 
# File 'lib/kaltura_types.rb', line 1411

def entries_count
  @entries_count
end

#full_ids ⇒ Object

The full ids of the Category



1408
1409
1410
 
# File 'lib/kaltura_types.rb', line 1408

def full_ids
  @full_ids
end

#full_name ⇒ Object

The full name of the Category



1405
1406
1407
 
# File 'lib/kaltura_types.rb', line 1405

def full_name
  @full_name
end

#id ⇒ Object

The id of the Category



1395
1396
1397
 
# File 'lib/kaltura_types.rb', line 1395

def id
  @id
end

#inheritance_type ⇒ Object

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



1432
1433
1434
 
# File 'lib/kaltura_types.rb', line 1432

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)



1468
1469
1470
 
# File 'lib/kaltura_types.rb', line 1468

def inherited_parent_id
  @inherited_parent_id
end

#members_count ⇒ Object

Number of active members for this category



1453
1454
1455
 
# File 'lib/kaltura_types.rb', line 1453

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.



1483
1484
1485
 
# File 'lib/kaltura_types.rb', line 1483

def moderation
  @moderation
end

#name ⇒ Object

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



1402
1403
1404
 
# File 'lib/kaltura_types.rb', line 1402

def name
  @name
end

#owner ⇒ Object

Category Owner (User id)



1441
1442
1443
 
# File 'lib/kaltura_types.rb', line 1441

def owner
  @owner
end

#parent_id ⇒ Object

Returns the value of attribute parent_id.



1396
1397
1398
 
# File 'lib/kaltura_types.rb', line 1396

def parent_id
  @parent_id
end

#partner_data ⇒ Object

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



1474
1475
1476
 
# File 'lib/kaltura_types.rb', line 1474

def partner_data
  @partner_data
end

#partner_id ⇒ Object

Returns the value of attribute partner_id.



1398
1399
1400
 
# File 'lib/kaltura_types.rb', line 1398

def partner_id
  @partner_id
end

#partner_sort_value ⇒ Object

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



1471
1472
1473
 
# File 'lib/kaltura_types.rb', line 1471

def partner_sort_value
  @partner_sort_value
end

#pending_entries_count ⇒ Object

Nunber of pending moderation entries



1486
1487
1488
 
# File 'lib/kaltura_types.rb', line 1486

def pending_entries_count
  @pending_entries_count
end

#pending_members_count ⇒ Object

Number of pending members for this category



1456
1457
1458
 
# File 'lib/kaltura_types.rb', line 1456

def pending_members_count
  @pending_members_count
end

#privacy ⇒ Object

defines the privacy of the entries that assigned to this category



1429
1430
1431
 
# File 'lib/kaltura_types.rb', line 1429

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.



1459
1460
1461
 
# File 'lib/kaltura_types.rb', line 1459

def privacy_context
  @privacy_context
end

#privacy_contexts ⇒ Object

comma separated parents that defines a privacyContext for search



1462
1463
1464
 
# File 'lib/kaltura_types.rb', line 1462

def privacy_contexts
  @privacy_contexts
end

#reference_id ⇒ Object

Category external id, controlled and managed by the partner.



1447
1448
1449
 
# File 'lib/kaltura_types.rb', line 1447

def reference_id
  @reference_id
end

#status ⇒ Object

Status



1465
1466
1467
 
# File 'lib/kaltura_types.rb', line 1465

def status
  @status
end

#tags ⇒ Object

Category tags



1423
1424
1425
 
# File 'lib/kaltura_types.rb', line 1423

def tags
  @tags
end

#updated_at ⇒ Object

Update date as Unix timestamp (In seconds)



1417
1418
1419
 
# File 'lib/kaltura_types.rb', line 1417

def updated_at
  @updated_at
end

#user_join_policy ⇒ Object

Who can ask to join this category



1435
1436
1437
 
# File 'lib/kaltura_types.rb', line 1435

def user_join_policy
  @user_join_policy
end

Instance Method Details

#from_xml(xml_element) ⇒ Object 



1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
 
# File 'lib/kaltura_types.rb', line 1555

def from_xml(xml_element)
  super
  self.id = xml_element.elements['id'].text
  self.parent_id = xml_element.elements['parentId'].text
  self.depth = xml_element.elements['depth'].text
  self.partner_id = xml_element.elements['partnerId'].text
  self.name = xml_element.elements['name'].text
  self.full_name = xml_element.elements['fullName'].text
  self.full_ids = xml_element.elements['fullIds'].text
  self.entries_count = xml_element.elements['entriesCount'].text
  self.created_at = xml_element.elements['createdAt'].text
  self.updated_at = xml_element.elements['updatedAt'].text
  self.description = xml_element.elements['description'].text
  self.tags = xml_element.elements['tags'].text
  self.appear_in_list = xml_element.elements['appearInList'].text
  self.privacy = xml_element.elements['privacy'].text
  self.inheritance_type = xml_element.elements['inheritanceType'].text
  self.user_join_policy = xml_element.elements['userJoinPolicy'].text
  self.default_permission_level = xml_element.elements['defaultPermissionLevel'].text
  self.owner = xml_element.elements['owner'].text
  self.direct_entries_count = xml_element.elements['directEntriesCount'].text
  self.reference_id = xml_element.elements['referenceId'].text
  self.contribution_policy = xml_element.elements['contributionPolicy'].text
  self.members_count = xml_element.elements['membersCount'].text
  self.pending_members_count = xml_element.elements['pendingMembersCount'].text
  self.privacy_context = xml_element.elements['privacyContext'].text
  self.privacy_contexts = xml_element.elements['privacyContexts'].text
  self.status = xml_element.elements['status'].text
  self.inherited_parent_id = xml_element.elements['inheritedParentId'].text
  self.partner_sort_value = xml_element.elements['partnerSortValue'].text
  self.partner_data = xml_element.elements['partnerData'].text
  self.default_order_by = xml_element.elements['defaultOrderBy'].text
  self.direct_sub_categories_count = xml_element.elements['directSubCategoriesCount'].text
  self.moderation = xml_element.elements['moderation'].text
  self.pending_entries_count = xml_element.elements['pendingEntriesCount'].text
end