Class: Kaltura::KalturaBaseEntry

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

#access_control_id ⇒ Object

The Access Control ID assigned to this entry (null when not set, send -1 to remove)



693
694
695
 
# File 'lib/kaltura_types.rb', line 693

def access_control_id
  @access_control_id
end

#admin_tags ⇒ Object

Entry admin tags can be updated only by administrators



640
641
642
 
# File 'lib/kaltura_types.rb', line 640

def admin_tags
  @admin_tags
end

#capabilities ⇒ Object

Comma seperated string of the capabilities of the entry. Any capability needed can be added to this list.



738
739
740
 
# File 'lib/kaltura_types.rb', line 738

def capabilities
  @capabilities
end

#categories ⇒ Object

Comma separated list of full names of categories to which this entry belongs. Only categories that don’t have entitlement (privacy context) are listed, to retrieve the full list of categories, use the categoryEntry.list action.



643
644
645
 
# File 'lib/kaltura_types.rb', line 643

def categories
  @categories
end

#categories_ids ⇒ Object

Comma separated list of ids of categories to which this entry belongs. Only categories that don’t have entitlement (privacy context) are listed, to retrieve the full list of categories, use the categoryEntry.list action.



646
647
648
 
# File 'lib/kaltura_types.rb', line 646

def categories_ids
  @categories_ids
end

#conversion_profile_id ⇒ Object

Override the default ingestion profile



717
718
719
 
# File 'lib/kaltura_types.rb', line 717

def conversion_profile_id
  @conversion_profile_id
end

#created_at ⇒ Object

Entry creation date as Unix timestamp (In seconds)



659
660
661
 
# File 'lib/kaltura_types.rb', line 659

def created_at
  @created_at
end

#creator_id ⇒ Object

The ID of the user who created this entry



634
635
636
 
# File 'lib/kaltura_types.rb', line 634

def creator_id
  @creator_id
end

#description ⇒ Object

Entry description



627
628
629
 
# File 'lib/kaltura_types.rb', line 627

def description
  @description
end

#download_url ⇒ Object

Download URL for the entry



678
679
680
 
# File 'lib/kaltura_types.rb', line 678

def download_url
  @download_url
end

#end_date ⇒ Object

Entry scheduling end date (null when not set, send -1 to remove)



699
700
701
 
# File 'lib/kaltura_types.rb', line 699

def end_date
  @end_date
end

#entitled_users_edit ⇒ Object

list of user ids that are entitled to edit the entry (no server enforcement) The difference between entitledUsersEdit and entitledUsersPublish is applicative only



732
733
734
 
# File 'lib/kaltura_types.rb', line 732

def entitled_users_edit
  @entitled_users_edit
end

#entitled_users_publish ⇒ Object

list of user ids that are entitled to publish the entry (no server enforcement) The difference between entitledUsersEdit and entitledUsersPublish is applicative only



735
736
737
 
# File 'lib/kaltura_types.rb', line 735

def entitled_users_publish
  @entitled_users_publish
end

#group_id ⇒ Object

Returns the value of attribute group_id.



672
673
674
 
# File 'lib/kaltura_types.rb', line 672

def group_id
  @group_id
end

#id ⇒ Object

Auto generated 10 characters alphanumeric string



621
622
623
 
# File 'lib/kaltura_types.rb', line 621

def id
  @id
end

#license_type ⇒ Object

License type used for this entry



684
685
686
 
# File 'lib/kaltura_types.rb', line 684

def license_type
  @license_type
end

#moderation_count ⇒ Object

Number of moderation requests waiting for this entry



653
654
655
 
# File 'lib/kaltura_types.rb', line 653

def moderation_count
  @moderation_count
end

#moderation_status ⇒ Object

Entry moderation status



650
651
652
 
# File 'lib/kaltura_types.rb', line 650

def moderation_status
  @moderation_status
end

#name ⇒ Object

Entry name (Min 1 chars)



624
625
626
 
# File 'lib/kaltura_types.rb', line 624

def name
  @name
end

#operation_attributes ⇒ Object

clipping, skipping and cropping attributes that used to create this entry



729
730
731
 
# File 'lib/kaltura_types.rb', line 729

def operation_attributes
  @operation_attributes
end

#parent_entry_id ⇒ Object

ID of source root entry, used for defining entires association



726
727
728
 
# File 'lib/kaltura_types.rb', line 726

def parent_entry_id
  @parent_entry_id
end

#partner_data ⇒ Object

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



675
676
677
 
# File 'lib/kaltura_types.rb', line 675

def partner_data
  @partner_data
end

#partner_id ⇒ Object

Returns the value of attribute partner_id.



628
629
630
 
# File 'lib/kaltura_types.rb', line 628

def partner_id
  @partner_id
end

#partner_sort_value ⇒ Object

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



714
715
716
 
# File 'lib/kaltura_types.rb', line 714

def partner_sort_value
  @partner_sort_value
end

#rank ⇒ Object

The calculated average rank. rank = totalRank / votes



665
666
667
 
# File 'lib/kaltura_types.rb', line 665

def rank
  @rank
end

#redirect_entry_id ⇒ Object

IF not empty, points to an entry ID the should replace this current entry’s id.



720
721
722
 
# File 'lib/kaltura_types.rb', line 720

def redirect_entry_id
  @redirect_entry_id
end

#reference_id ⇒ Object

Entry external reference id



702
703
704
 
# File 'lib/kaltura_types.rb', line 702

def reference_id
  @reference_id
end

#replaced_entry_id ⇒ Object

ID of the entry that will be replaced when the replacement approved and this entry is ready



708
709
710
 
# File 'lib/kaltura_types.rb', line 708

def replaced_entry_id
  @replaced_entry_id
end

#replacement_status ⇒ Object

Status of the replacement readiness and approval



711
712
713
 
# File 'lib/kaltura_types.rb', line 711

def replacement_status
  @replacement_status
end

#replacing_entry_id ⇒ Object

ID of temporary entry that will replace this entry when it’s approved and ready for replacement



705
706
707
 
# File 'lib/kaltura_types.rb', line 705

def replacing_entry_id
  @replacing_entry_id
end

#root_entry_id ⇒ Object

ID of source root entry, used for clipped, skipped and cropped entries that created from another entry



723
724
725
 
# File 'lib/kaltura_types.rb', line 723

def root_entry_id
  @root_entry_id
end

#search_text ⇒ Object

Indexed search text for full text search



681
682
683
 
# File 'lib/kaltura_types.rb', line 681

def search_text
  @search_text
end

#start_date ⇒ Object

Entry scheduling start date (null when not set, send -1 to remove)



696
697
698
 
# File 'lib/kaltura_types.rb', line 696

def start_date
  @start_date
end

#status ⇒ Object

Returns the value of attribute status.



647
648
649
 
# File 'lib/kaltura_types.rb', line 647

def status
  @status
end

#tags ⇒ Object

Entry tags



637
638
639
 
# File 'lib/kaltura_types.rb', line 637

def tags
  @tags
end

#thumbnail_url ⇒ Object

Thumbnail URL



690
691
692
 
# File 'lib/kaltura_types.rb', line 690

def thumbnail_url
  @thumbnail_url
end

#total_rank ⇒ Object

The sum of all rank values submitted to the baseEntry.anonymousRank action



668
669
670
 
# File 'lib/kaltura_types.rb', line 668

def total_rank
  @total_rank
end

#type ⇒ Object

The type of the entry, this is auto filled by the derived entry object



656
657
658
 
# File 'lib/kaltura_types.rb', line 656

def type
  @type
end

#updated_at ⇒ Object

Entry update date as Unix timestamp (In seconds)



662
663
664
 
# File 'lib/kaltura_types.rb', line 662

def updated_at
  @updated_at
end

#user_id ⇒ Object

The ID of the user who is the owner of this entry



631
632
633
 
# File 'lib/kaltura_types.rb', line 631

def user_id
  @user_id
end

#version ⇒ Object

Version of the entry data



687
688
689
 
# File 'lib/kaltura_types.rb', line 687

def version
  @version
end

#votes ⇒ Object

A count of all requests made to the baseEntry.anonymousRank action



671
672
673
 
# File 'lib/kaltura_types.rb', line 671

def votes
  @votes
end

Instance Method Details

#from_xml(xml_element) ⇒ Object 



789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
 
# File 'lib/kaltura_types.rb', line 789

def from_xml(xml_element)
  super
  self.id = xml_element.elements['id'].text
  self.name = xml_element.elements['name'].text
  self.description = xml_element.elements['description'].text
  self.partner_id = xml_element.elements['partnerId'].text
  self.user_id = xml_element.elements['userId'].text
  self.creator_id = xml_element.elements['creatorId'].text
  self.tags = xml_element.elements['tags'].text
  self.admin_tags = xml_element.elements['adminTags'].text
  self.categories = xml_element.elements['categories'].text
  self.categories_ids = xml_element.elements['categoriesIds'].text
  self.status = xml_element.elements['status'].text
  self.moderation_status = xml_element.elements['moderationStatus'].text
  self.moderation_count = xml_element.elements['moderationCount'].text
  self.type = xml_element.elements['type'].text
  self.created_at = xml_element.elements['createdAt'].text
  self.updated_at = xml_element.elements['updatedAt'].text
  self.rank = xml_element.elements['rank'].text
  self.total_rank = xml_element.elements['totalRank'].text
  self.votes = xml_element.elements['votes'].text
  self.group_id = xml_element.elements['groupId'].text
  self.partner_data = xml_element.elements['partnerData'].text
  self.download_url = xml_element.elements['downloadUrl'].text
  self.search_text = xml_element.elements['searchText'].text
  self.license_type = xml_element.elements['licenseType'].text
  self.version = xml_element.elements['version'].text
  self.thumbnail_url = xml_element.elements['thumbnailUrl'].text
  self.access_control_id = xml_element.elements['accessControlId'].text
  self.start_date = xml_element.elements['startDate'].text
  self.end_date = xml_element.elements['endDate'].text
  self.reference_id = xml_element.elements['referenceId'].text
  self.replacing_entry_id = xml_element.elements['replacingEntryId'].text
  self.replaced_entry_id = xml_element.elements['replacedEntryId'].text
  self.replacement_status = xml_element.elements['replacementStatus'].text
  self.partner_sort_value = xml_element.elements['partnerSortValue'].text
  self.conversion_profile_id = xml_element.elements['conversionProfileId'].text
  self.redirect_entry_id = xml_element.elements['redirectEntryId'].text
  self.root_entry_id = xml_element.elements['rootEntryId'].text
  self.parent_entry_id = xml_element.elements['parentEntryId'].text
  self.operation_attributes = KalturaClientBase.object_from_xml(xml_element.elements['operationAttributes'], 'KalturaOperationAttributes')
  self.entitled_users_edit = xml_element.elements['entitledUsersEdit'].text
  self.entitled_users_publish = xml_element.elements['entitledUsersPublish'].text
  self.capabilities = xml_element.elements['capabilities'].text
end