Class: Kaltura::KalturaBaseEntry
- Inherits:
-
KalturaObjectBase
- Object
- KalturaObjectBase
- Kaltura::KalturaBaseEntry
- Defined in:
- lib/kaltura_types.rb
Direct Known Subclasses
KalturaDataEntry, KalturaDocumentEntry, KalturaPlayableEntry, KalturaPlaylist
Instance Attribute Summary collapse
-
#access_control_id ⇒ Object
The Access Control ID assigned to this entry (null when not set, send -1 to remove).
-
#admin_tags ⇒ Object
Entry admin tags can be updated only by administrators.
-
#capabilities ⇒ Object
Comma seperated string of the capabilities of the entry.
-
#categories ⇒ Object
Comma separated list of full names of categories to which this entry belongs.
-
#categories_ids ⇒ Object
Comma separated list of ids of categories to which this entry belongs.
-
#conversion_profile_id ⇒ Object
Override the default ingestion profile.
-
#created_at ⇒ Object
Entry creation date as Unix timestamp (In seconds).
-
#creator_id ⇒ Object
The ID of the user who created this entry.
-
#description ⇒ Object
Entry description.
-
#display_in_search ⇒ Object
should we display this entry in search.
-
#download_url ⇒ Object
Download URL for the entry.
-
#end_date ⇒ Object
Entry scheduling end date (null when not set, send -1 to remove).
-
#entitled_users_edit ⇒ Object
list of user ids that are entitled to edit the entry (no server enforcement) The difference between entitledUsersEdit, entitledUsersPublish and entitledUsersView is applicative only.
-
#entitled_users_publish ⇒ Object
list of user ids that are entitled to publish the entry (no server enforcement) The difference between entitledUsersEdit, entitledUsersPublish and entitledUsersView is applicative only.
-
#entitled_users_view ⇒ Object
list of user ids that are entitled to view the entry (no server enforcement) The difference between entitledUsersEdit, entitledUsersPublish and entitledUsersView is applicative only.
-
#group_id ⇒ Object
Returns the value of attribute group_id.
-
#id ⇒ Object
Auto generated 10 characters alphanumeric string.
-
#license_type ⇒ Object
License type used for this entry.
-
#moderation_count ⇒ Object
Number of moderation requests waiting for this entry.
-
#moderation_status ⇒ Object
Entry moderation status.
-
#name ⇒ Object
Entry name (Min 1 chars).
-
#operation_attributes ⇒ Object
clipping, skipping and cropping attributes that used to create this entry.
-
#parent_entry_id ⇒ Object
ID of source root entry, used for defining entires association.
-
#partner_data ⇒ Object
Can be used to store various partner related data as a string.
-
#partner_id ⇒ Object
Returns the value of attribute partner_id.
-
#partner_sort_value ⇒ Object
Can be used to store various partner related data as a numeric value.
-
#rank ⇒ Object
The calculated average rank.
-
#redirect_entry_id ⇒ Object
IF not empty, points to an entry ID the should replace this current entry’s id.
-
#reference_id ⇒ Object
Entry external reference id.
-
#replaced_entry_id ⇒ Object
ID of the entry that will be replaced when the replacement approved and this entry is ready.
-
#replacement_status ⇒ Object
Status of the replacement readiness and approval.
-
#replacing_entry_id ⇒ Object
ID of temporary entry that will replace this entry when it’s approved and ready for replacement.
-
#root_entry_id ⇒ Object
ID of source root entry, used for clipped, skipped and cropped entries that created from another entry.
-
#search_text ⇒ Object
Indexed search text for full text search.
-
#start_date ⇒ Object
Entry scheduling start date (null when not set, send -1 to remove).
-
#status ⇒ Object
Returns the value of attribute status.
-
#tags ⇒ Object
Entry tags.
-
#template_entry_id ⇒ Object
Template entry id.
-
#thumbnail_url ⇒ Object
Thumbnail URL.
-
#total_rank ⇒ Object
The sum of all rank values submitted to the baseEntry.anonymousRank action.
-
#type ⇒ Object
The type of the entry, this is auto filled by the derived entry object.
-
#updated_at ⇒ Object
Entry update date as Unix timestamp (In seconds).
-
#user_id ⇒ Object
The ID of the user who is the owner of this entry.
-
#version ⇒ Object
Version of the entry data.
-
#votes ⇒ Object
A count of all requests made to the baseEntry.anonymousRank action.
Attributes inherited from KalturaObjectBase
#object_type, #related_objects
Instance Method Summary collapse
Methods inherited from KalturaObjectBase
Instance Attribute Details
#access_control_id ⇒ Object
The Access Control ID assigned to this entry (null when not set, send -1 to remove)
906 907 908 |
# File 'lib/kaltura_types.rb', line 906 def access_control_id @access_control_id end |
#admin_tags ⇒ Object
Entry admin tags can be updated only by administrators
870 871 872 |
# File 'lib/kaltura_types.rb', line 870 def @admin_tags end |
#capabilities ⇒ Object
Comma seperated string of the capabilities of the entry. Any capability needed can be added to this list.
938 939 940 |
# File 'lib/kaltura_types.rb', line 938 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.
872 873 874 |
# File 'lib/kaltura_types.rb', line 872 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.
874 875 876 |
# File 'lib/kaltura_types.rb', line 874 def categories_ids @categories_ids end |
#conversion_profile_id ⇒ Object
Override the default ingestion profile
922 923 924 |
# File 'lib/kaltura_types.rb', line 922 def conversion_profile_id @conversion_profile_id end |
#created_at ⇒ Object
Entry creation date as Unix timestamp (In seconds)
883 884 885 |
# File 'lib/kaltura_types.rb', line 883 def created_at @created_at end |
#creator_id ⇒ Object
The ID of the user who created this entry
866 867 868 |
# File 'lib/kaltura_types.rb', line 866 def creator_id @creator_id end |
#description ⇒ Object
Entry description
861 862 863 |
# File 'lib/kaltura_types.rb', line 861 def description @description end |
#display_in_search ⇒ Object
should we display this entry in search
942 943 944 |
# File 'lib/kaltura_types.rb', line 942 def display_in_search @display_in_search end |
#download_url ⇒ Object
Download URL for the entry
896 897 898 |
# File 'lib/kaltura_types.rb', line 896 def download_url @download_url end |
#end_date ⇒ Object
Entry scheduling end date (null when not set, send -1 to remove)
910 911 912 |
# File 'lib/kaltura_types.rb', line 910 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, entitledUsersPublish and entitledUsersView is applicative only
932 933 934 |
# File 'lib/kaltura_types.rb', line 932 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, entitledUsersPublish and entitledUsersView is applicative only
934 935 936 |
# File 'lib/kaltura_types.rb', line 934 def entitled_users_publish @entitled_users_publish end |
#entitled_users_view ⇒ Object
list of user ids that are entitled to view the entry (no server enforcement) The difference between entitledUsersEdit, entitledUsersPublish and entitledUsersView is applicative only
936 937 938 |
# File 'lib/kaltura_types.rb', line 936 def entitled_users_view @entitled_users_view end |
#group_id ⇒ Object
Returns the value of attribute group_id.
892 893 894 |
# File 'lib/kaltura_types.rb', line 892 def group_id @group_id end |
#id ⇒ Object
Auto generated 10 characters alphanumeric string
857 858 859 |
# File 'lib/kaltura_types.rb', line 857 def id @id end |
#license_type ⇒ Object
License type used for this entry
900 901 902 |
# File 'lib/kaltura_types.rb', line 900 def license_type @license_type end |
#moderation_count ⇒ Object
Number of moderation requests waiting for this entry
879 880 881 |
# File 'lib/kaltura_types.rb', line 879 def moderation_count @moderation_count end |
#moderation_status ⇒ Object
Entry moderation status
877 878 879 |
# File 'lib/kaltura_types.rb', line 877 def moderation_status @moderation_status end |
#name ⇒ Object
Entry name (Min 1 chars)
859 860 861 |
# File 'lib/kaltura_types.rb', line 859 def name @name end |
#operation_attributes ⇒ Object
clipping, skipping and cropping attributes that used to create this entry
930 931 932 |
# File 'lib/kaltura_types.rb', line 930 def operation_attributes @operation_attributes end |
#parent_entry_id ⇒ Object
ID of source root entry, used for defining entires association
928 929 930 |
# File 'lib/kaltura_types.rb', line 928 def parent_entry_id @parent_entry_id end |
#partner_data ⇒ Object
Can be used to store various partner related data as a string
894 895 896 |
# File 'lib/kaltura_types.rb', line 894 def partner_data @partner_data end |
#partner_id ⇒ Object
Returns the value of attribute partner_id.
862 863 864 |
# File 'lib/kaltura_types.rb', line 862 def partner_id @partner_id end |
#partner_sort_value ⇒ Object
Can be used to store various partner related data as a numeric value
920 921 922 |
# File 'lib/kaltura_types.rb', line 920 def partner_sort_value @partner_sort_value end |
#rank ⇒ Object
The calculated average rank. rank = totalRank / votes
887 888 889 |
# File 'lib/kaltura_types.rb', line 887 def rank @rank end |
#redirect_entry_id ⇒ Object
IF not empty, points to an entry ID the should replace this current entry’s id.
924 925 926 |
# File 'lib/kaltura_types.rb', line 924 def redirect_entry_id @redirect_entry_id end |
#reference_id ⇒ Object
Entry external reference id
912 913 914 |
# File 'lib/kaltura_types.rb', line 912 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
916 917 918 |
# File 'lib/kaltura_types.rb', line 916 def replaced_entry_id @replaced_entry_id end |
#replacement_status ⇒ Object
Status of the replacement readiness and approval
918 919 920 |
# File 'lib/kaltura_types.rb', line 918 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
914 915 916 |
# File 'lib/kaltura_types.rb', line 914 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
926 927 928 |
# File 'lib/kaltura_types.rb', line 926 def root_entry_id @root_entry_id end |
#search_text ⇒ Object
Indexed search text for full text search
898 899 900 |
# File 'lib/kaltura_types.rb', line 898 def search_text @search_text end |
#start_date ⇒ Object
Entry scheduling start date (null when not set, send -1 to remove)
908 909 910 |
# File 'lib/kaltura_types.rb', line 908 def start_date @start_date end |
#status ⇒ Object
Returns the value of attribute status.
875 876 877 |
# File 'lib/kaltura_types.rb', line 875 def status @status end |
#tags ⇒ Object
Entry tags
868 869 870 |
# File 'lib/kaltura_types.rb', line 868 def @tags end |
#template_entry_id ⇒ Object
Template entry id
940 941 942 |
# File 'lib/kaltura_types.rb', line 940 def template_entry_id @template_entry_id end |
#thumbnail_url ⇒ Object
Thumbnail URL
904 905 906 |
# File 'lib/kaltura_types.rb', line 904 def thumbnail_url @thumbnail_url end |
#total_rank ⇒ Object
The sum of all rank values submitted to the baseEntry.anonymousRank action
889 890 891 |
# File 'lib/kaltura_types.rb', line 889 def total_rank @total_rank end |
#type ⇒ Object
The type of the entry, this is auto filled by the derived entry object
881 882 883 |
# File 'lib/kaltura_types.rb', line 881 def type @type end |
#updated_at ⇒ Object
Entry update date as Unix timestamp (In seconds)
885 886 887 |
# File 'lib/kaltura_types.rb', line 885 def updated_at @updated_at end |
#user_id ⇒ Object
The ID of the user who is the owner of this entry
864 865 866 |
# File 'lib/kaltura_types.rb', line 864 def user_id @user_id end |
#version ⇒ Object
Version of the entry data
902 903 904 |
# File 'lib/kaltura_types.rb', line 902 def version @version end |
#votes ⇒ Object
A count of all requests made to the baseEntry.anonymousRank action
891 892 893 |
# File 'lib/kaltura_types.rb', line 891 def votes @votes end |
Instance Method Details
#from_xml(xml_element) ⇒ Object
996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 |
# File 'lib/kaltura_types.rb', line 996 def from_xml(xml_element) super if xml_element.elements['id'] != nil self.id = xml_element.elements['id'].text end if xml_element.elements['name'] != nil self.name = xml_element.elements['name'].text end if xml_element.elements['description'] != nil self.description = xml_element.elements['description'].text end if xml_element.elements['partnerId'] != nil self.partner_id = xml_element.elements['partnerId'].text end if xml_element.elements['userId'] != nil self.user_id = xml_element.elements['userId'].text end if xml_element.elements['creatorId'] != nil self.creator_id = xml_element.elements['creatorId'].text end if xml_element.elements['tags'] != nil self. = xml_element.elements['tags'].text end if xml_element.elements['adminTags'] != nil self. = xml_element.elements['adminTags'].text end if xml_element.elements['categories'] != nil self.categories = xml_element.elements['categories'].text end if xml_element.elements['categoriesIds'] != nil self.categories_ids = xml_element.elements['categoriesIds'].text end if xml_element.elements['status'] != nil self.status = xml_element.elements['status'].text end if xml_element.elements['moderationStatus'] != nil self.moderation_status = xml_element.elements['moderationStatus'].text end if xml_element.elements['moderationCount'] != nil self.moderation_count = xml_element.elements['moderationCount'].text end if xml_element.elements['type'] != nil self.type = xml_element.elements['type'].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['rank'] != nil self.rank = xml_element.elements['rank'].text end if xml_element.elements['totalRank'] != nil self.total_rank = xml_element.elements['totalRank'].text end if xml_element.elements['votes'] != nil self.votes = xml_element.elements['votes'].text end if xml_element.elements['groupId'] != nil self.group_id = xml_element.elements['groupId'].text end if xml_element.elements['partnerData'] != nil self.partner_data = xml_element.elements['partnerData'].text end if xml_element.elements['downloadUrl'] != nil self.download_url = xml_element.elements['downloadUrl'].text end if xml_element.elements['searchText'] != nil self.search_text = xml_element.elements['searchText'].text end if xml_element.elements['licenseType'] != nil self.license_type = xml_element.elements['licenseType'].text end if xml_element.elements['version'] != nil self.version = xml_element.elements['version'].text end if xml_element.elements['thumbnailUrl'] != nil self.thumbnail_url = xml_element.elements['thumbnailUrl'].text end if xml_element.elements['accessControlId'] != nil self.access_control_id = xml_element.elements['accessControlId'].text end if xml_element.elements['startDate'] != nil self.start_date = xml_element.elements['startDate'].text end if xml_element.elements['endDate'] != nil self.end_date = xml_element.elements['endDate'].text end if xml_element.elements['referenceId'] != nil self.reference_id = xml_element.elements['referenceId'].text end if xml_element.elements['replacingEntryId'] != nil self.replacing_entry_id = xml_element.elements['replacingEntryId'].text end if xml_element.elements['replacedEntryId'] != nil self.replaced_entry_id = xml_element.elements['replacedEntryId'].text end if xml_element.elements['replacementStatus'] != nil self.replacement_status = xml_element.elements['replacementStatus'].text end if xml_element.elements['partnerSortValue'] != nil self.partner_sort_value = xml_element.elements['partnerSortValue'].text end if xml_element.elements['conversionProfileId'] != nil self.conversion_profile_id = xml_element.elements['conversionProfileId'].text end if xml_element.elements['redirectEntryId'] != nil self.redirect_entry_id = xml_element.elements['redirectEntryId'].text end if xml_element.elements['rootEntryId'] != nil self.root_entry_id = xml_element.elements['rootEntryId'].text end if xml_element.elements['parentEntryId'] != nil self.parent_entry_id = xml_element.elements['parentEntryId'].text end if xml_element.elements['operationAttributes'] != nil self.operation_attributes = KalturaClientBase.object_from_xml(xml_element.elements['operationAttributes'], 'KalturaOperationAttributes') end if xml_element.elements['entitledUsersEdit'] != nil self.entitled_users_edit = xml_element.elements['entitledUsersEdit'].text end if xml_element.elements['entitledUsersPublish'] != nil self.entitled_users_publish = xml_element.elements['entitledUsersPublish'].text end if xml_element.elements['entitledUsersView'] != nil self.entitled_users_view = xml_element.elements['entitledUsersView'].text end if xml_element.elements['capabilities'] != nil self.capabilities = xml_element.elements['capabilities'].text end if xml_element.elements['templateEntryId'] != nil self.template_entry_id = xml_element.elements['templateEntryId'].text end if xml_element.elements['displayInSearch'] != nil self.display_in_search = xml_element.elements['displayInSearch'].text end end |