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)



940
941
942
 
# File 'lib/kaltura_types.rb', line 940

def access_control_id
  @access_control_id
end

#admin_tags ⇒ Object

Entry admin tags can be updated only by administrators



904
905
906
 
# File 'lib/kaltura_types.rb', line 904

def admin_tags
  @admin_tags
end

#application ⇒ Object

Entry application



978
979
980
 
# File 'lib/kaltura_types.rb', line 978

def application
  @application
end

#application_version ⇒ Object

Entry application version



980
981
982
 
# File 'lib/kaltura_types.rb', line 980

def application_version
  @application_version
end

#block_auto_transcript ⇒ Object

Block auto transcript on Entry



982
983
984
 
# File 'lib/kaltura_types.rb', line 982

def block_auto_transcript
  @block_auto_transcript
end

#capabilities ⇒ Object

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



972
973
974
 
# File 'lib/kaltura_types.rb', line 972

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.



906
907
908
 
# File 'lib/kaltura_types.rb', line 906

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.



908
909
910
 
# File 'lib/kaltura_types.rb', line 908

def categories_ids
  @categories_ids
end

#conversion_profile_id ⇒ Object

Override the default ingestion profile



956
957
958
 
# File 'lib/kaltura_types.rb', line 956

def conversion_profile_id
  @conversion_profile_id
end

#created_at ⇒ Object

Entry creation date as Unix timestamp (In seconds)



917
918
919
 
# File 'lib/kaltura_types.rb', line 917

def created_at
  @created_at
end

#creator_id ⇒ Object

The ID of the user who created this entry



898
899
900
 
# File 'lib/kaltura_types.rb', line 898

def creator_id
  @creator_id
end

#description ⇒ Object

Entry description



891
892
893
 
# File 'lib/kaltura_types.rb', line 891

def description
  @description
end

#display_in_search ⇒ Object

should we display this entry in search



976
977
978
 
# File 'lib/kaltura_types.rb', line 976

def display_in_search
  @display_in_search
end

#download_url ⇒ Object

Download URL for the entry



930
931
932
 
# File 'lib/kaltura_types.rb', line 930

def download_url
  @download_url
end

#end_date ⇒ Object

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



944
945
946
 
# File 'lib/kaltura_types.rb', line 944

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



966
967
968
 
# File 'lib/kaltura_types.rb', line 966

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



968
969
970
 
# File 'lib/kaltura_types.rb', line 968

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



970
971
972
 
# File 'lib/kaltura_types.rb', line 970

def entitled_users_view
  @entitled_users_view
end

#group_id ⇒ Object

Returns the value of attribute group_id.



926
927
928
 
# File 'lib/kaltura_types.rb', line 926

def group_id
  @group_id
end

#id ⇒ Object

Auto generated 10 characters alphanumeric string



885
886
887
 
# File 'lib/kaltura_types.rb', line 885

def id
  @id
end

#license_type ⇒ Object

License type used for this entry



934
935
936
 
# File 'lib/kaltura_types.rb', line 934

def license_type
  @license_type
end

#moderation_count ⇒ Object

Number of moderation requests waiting for this entry



913
914
915
 
# File 'lib/kaltura_types.rb', line 913

def moderation_count
  @moderation_count
end

#moderation_status ⇒ Object

Entry moderation status



911
912
913
 
# File 'lib/kaltura_types.rb', line 911

def moderation_status
  @moderation_status
end

#multi_lingual_description ⇒ Object

Entry description



893
894
895
 
# File 'lib/kaltura_types.rb', line 893

def multi_lingual_description
  @multi_lingual_description
end

#multi_lingual_name ⇒ Object

Entry name (Min 1 chars)



889
890
891
 
# File 'lib/kaltura_types.rb', line 889

def multi_lingual_name
  @multi_lingual_name
end

#multi_lingual_tags ⇒ Object

Entry tags



902
903
904
 
# File 'lib/kaltura_types.rb', line 902

def multi_lingual_tags
  @multi_lingual_tags
end

#name ⇒ Object

Entry name (Min 1 chars)



887
888
889
 
# File 'lib/kaltura_types.rb', line 887

def name
  @name
end

#operation_attributes ⇒ Object

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



964
965
966
 
# File 'lib/kaltura_types.rb', line 964

def operation_attributes
  @operation_attributes
end

#parent_entry_id ⇒ Object

ID of source root entry, used for defining entires association



962
963
964
 
# File 'lib/kaltura_types.rb', line 962

def parent_entry_id
  @parent_entry_id
end

#partner_data ⇒ Object

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



928
929
930
 
# File 'lib/kaltura_types.rb', line 928

def partner_data
  @partner_data
end

#partner_id ⇒ Object

Returns the value of attribute partner_id.



894
895
896
 
# File 'lib/kaltura_types.rb', line 894

def partner_id
  @partner_id
end

#partner_sort_value ⇒ Object

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



954
955
956
 
# File 'lib/kaltura_types.rb', line 954

def partner_sort_value
  @partner_sort_value
end

#rank ⇒ Object

The calculated average rank. rank = totalRank / votes



921
922
923
 
# File 'lib/kaltura_types.rb', line 921

def rank
  @rank
end

#redirect_entry_id ⇒ Object

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



958
959
960
 
# File 'lib/kaltura_types.rb', line 958

def redirect_entry_id
  @redirect_entry_id
end

#reference_id ⇒ Object

Entry external reference id



946
947
948
 
# File 'lib/kaltura_types.rb', line 946

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



950
951
952
 
# File 'lib/kaltura_types.rb', line 950

def replaced_entry_id
  @replaced_entry_id
end

#replacement_status ⇒ Object

Status of the replacement readiness and approval



952
953
954
 
# File 'lib/kaltura_types.rb', line 952

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



948
949
950
 
# File 'lib/kaltura_types.rb', line 948

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



960
961
962
 
# File 'lib/kaltura_types.rb', line 960

def root_entry_id
  @root_entry_id
end

#search_text ⇒ Object

Indexed search text for full text search



932
933
934
 
# File 'lib/kaltura_types.rb', line 932

def search_text
  @search_text
end

#start_date ⇒ Object

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



942
943
944
 
# File 'lib/kaltura_types.rb', line 942

def start_date
  @start_date
end

#status ⇒ Object

Returns the value of attribute status.



909
910
911
 
# File 'lib/kaltura_types.rb', line 909

def status
  @status
end

#tags ⇒ Object

Entry tags



900
901
902
 
# File 'lib/kaltura_types.rb', line 900

def tags
  @tags
end

#template_entry_id ⇒ Object

Template entry id



974
975
976
 
# File 'lib/kaltura_types.rb', line 974

def template_entry_id
  @template_entry_id
end

#thumbnail_url ⇒ Object

Thumbnail URL



938
939
940
 
# File 'lib/kaltura_types.rb', line 938

def thumbnail_url
  @thumbnail_url
end

#total_rank ⇒ Object

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



923
924
925
 
# File 'lib/kaltura_types.rb', line 923

def total_rank
  @total_rank
end

#type ⇒ Object

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



915
916
917
 
# File 'lib/kaltura_types.rb', line 915

def type
  @type
end

#updated_at ⇒ Object

Entry update date as Unix timestamp (In seconds)



919
920
921
 
# File 'lib/kaltura_types.rb', line 919

def updated_at
  @updated_at
end

#user_id ⇒ Object

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



896
897
898
 
# File 'lib/kaltura_types.rb', line 896

def user_id
  @user_id
end

#version ⇒ Object

Version of the entry data



936
937
938
 
# File 'lib/kaltura_types.rb', line 936

def version
  @version
end

#votes ⇒ Object

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



925
926
927
 
# File 'lib/kaltura_types.rb', line 925

def votes
  @votes
end

Instance Method Details

#from_xml(xml_element) ⇒ Object 



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
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'lib/kaltura_types.rb', line 1039

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['multiLingual_name'] != nil
		self.multi_lingual_name = KalturaClientBase.object_from_xml(xml_element.elements['multiLingual_name'], 'KalturaMultiLingualString')
	end
	if xml_element.elements['description'] != nil
		self.description = xml_element.elements['description'].text
	end
	if xml_element.elements['multiLingual_description'] != nil
		self.multi_lingual_description = KalturaClientBase.object_from_xml(xml_element.elements['multiLingual_description'], 'KalturaMultiLingualString')
	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.tags = xml_element.elements['tags'].text
	end
	if xml_element.elements['multiLingual_tags'] != nil
		self.multi_lingual_tags = KalturaClientBase.object_from_xml(xml_element.elements['multiLingual_tags'], 'KalturaMultiLingualString')
	end
	if xml_element.elements['adminTags'] != nil
		self.admin_tags = 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
	if xml_element.elements['application'] != nil
		self.application = xml_element.elements['application'].text
	end
	if xml_element.elements['applicationVersion'] != nil
		self.application_version = xml_element.elements['applicationVersion'].text
	end
	if xml_element.elements['blockAutoTranscript'] != nil
		self.block_auto_transcript = xml_element.elements['blockAutoTranscript'].text
	end
end