Class: KalturaApi::KalturaCategory
- Inherits:
-
KalturaObjectBase
- Object
- KalturaObjectBase
- KalturaApi::KalturaCategory
- Defined in:
- lib/kaltura_client.rb
Instance Attribute Summary collapse
-
#appear_in_list ⇒ Object
If category will be returned for list action.
-
#contribution_policy ⇒ Object
who can assign entries to this category.
-
#created_at ⇒ Object
Creation date as Unix timestamp (In seconds).
-
#default_order_by ⇒ Object
Enable client side applications to define how to sort the category child categories.
-
#default_permission_level ⇒ Object
Default permissionLevel for new users.
-
#depth ⇒ Object
Returns the value of attribute depth.
-
#description ⇒ Object
Category description.
-
#direct_entries_count ⇒ Object
Number of entries that belong to this category directly.
-
#direct_sub_categories_count ⇒ Object
Number of direct children categories.
-
#entries_count ⇒ Object
Number of entries in this Category (including child categories).
-
#full_ids ⇒ Object
The full ids of the Category.
-
#full_name ⇒ Object
The full name of the Category.
-
#id ⇒ Object
The id of the Category.
-
#inheritance_type ⇒ Object
If Category members are inherited from parent category or set manualy.
-
#inherited_parent_id ⇒ Object
The category id that this category inherit its members and members permission (for contribution and join).
-
#members_count ⇒ Object
Number of active members for this category.
-
#moderation ⇒ Object
Moderation to add entries to this category by users that are not of permission level Manager or Moderator.
-
#name ⇒ Object
The name of the Category.
-
#owner ⇒ Object
Category Owner (User id).
-
#parent_id ⇒ Object
Returns the value of attribute parent_id.
-
#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.
-
#pending_entries_count ⇒ Object
Nunber of pending moderation entries.
-
#pending_members_count ⇒ Object
Number of pending members for this category.
-
#privacy ⇒ Object
defines the privacy of the entries that assigned to this category.
-
#privacy_context ⇒ Object
Set privacy context for search entries that assiged to private and public categories.
-
#privacy_contexts ⇒ Object
comma separated parents that defines a privacyContext for search.
-
#reference_id ⇒ Object
Category external id, controlled and managed by the partner.
-
#status ⇒ Object
Status.
-
#tags ⇒ Object
Category tags.
-
#updated_at ⇒ Object
Update date as Unix timestamp (In seconds).
-
#user_join_policy ⇒ Object
Who can ask to join this category.
Attributes inherited from KalturaObjectBase
Method Summary
Methods inherited from KalturaObjectBase
Instance Attribute Details
#appear_in_list ⇒ Object
If category will be returned for list action.
3069 3070 3071 |
# File 'lib/kaltura_client.rb', line 3069 def appear_in_list @appear_in_list end |
#contribution_policy ⇒ Object
who can assign entries to this category
3093 3094 3095 |
# File 'lib/kaltura_client.rb', line 3093 def contribution_policy @contribution_policy end |
#created_at ⇒ Object
Creation date as Unix timestamp (In seconds)
3057 3058 3059 |
# File 'lib/kaltura_client.rb', line 3057 def created_at @created_at end |
#default_order_by ⇒ Object
Enable client side applications to define how to sort the category child categories
3120 3121 3122 |
# File 'lib/kaltura_client.rb', line 3120 def default_order_by @default_order_by end |
#default_permission_level ⇒ Object
Default permissionLevel for new users
3081 3082 3083 |
# File 'lib/kaltura_client.rb', line 3081 def @default_permission_level end |
#depth ⇒ Object
Returns the value of attribute depth.
3040 3041 3042 |
# File 'lib/kaltura_client.rb', line 3040 def depth @depth end |
#description ⇒ Object
Category description
3063 3064 3065 |
# File 'lib/kaltura_client.rb', line 3063 def description @description end |
#direct_entries_count ⇒ Object
Number of entries that belong to this category directly
3087 3088 3089 |
# File 'lib/kaltura_client.rb', line 3087 def direct_entries_count @direct_entries_count end |
#direct_sub_categories_count ⇒ Object
Number of direct children categories
3123 3124 3125 |
# File 'lib/kaltura_client.rb', line 3123 def direct_sub_categories_count @direct_sub_categories_count end |
#entries_count ⇒ Object
Number of entries in this Category (including child categories)
3054 3055 3056 |
# File 'lib/kaltura_client.rb', line 3054 def entries_count @entries_count end |
#full_ids ⇒ Object
The full ids of the Category
3051 3052 3053 |
# File 'lib/kaltura_client.rb', line 3051 def full_ids @full_ids end |
#full_name ⇒ Object
The full name of the Category
3048 3049 3050 |
# File 'lib/kaltura_client.rb', line 3048 def full_name @full_name end |
#id ⇒ Object
The id of the Category
3038 3039 3040 |
# File 'lib/kaltura_client.rb', line 3038 def id @id end |
#inheritance_type ⇒ Object
If Category members are inherited from parent category or set manualy.
3075 3076 3077 |
# File 'lib/kaltura_client.rb', line 3075 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)
3111 3112 3113 |
# File 'lib/kaltura_client.rb', line 3111 def inherited_parent_id @inherited_parent_id end |
#members_count ⇒ Object
Number of active members for this category
3096 3097 3098 |
# File 'lib/kaltura_client.rb', line 3096 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.
3126 3127 3128 |
# File 'lib/kaltura_client.rb', line 3126 def moderation @moderation end |
#name ⇒ Object
The name of the Category. The following characters are not allowed: ‘<’, ‘>’, ‘,’
3045 3046 3047 |
# File 'lib/kaltura_client.rb', line 3045 def name @name end |
#owner ⇒ Object
Category Owner (User id)
3084 3085 3086 |
# File 'lib/kaltura_client.rb', line 3084 def owner @owner end |
#parent_id ⇒ Object
Returns the value of attribute parent_id.
3039 3040 3041 |
# File 'lib/kaltura_client.rb', line 3039 def parent_id @parent_id end |
#partner_data ⇒ Object
Can be used to store various partner related data as a string
3117 3118 3119 |
# File 'lib/kaltura_client.rb', line 3117 def partner_data @partner_data end |
#partner_id ⇒ Object
Returns the value of attribute partner_id.
3041 3042 3043 |
# File 'lib/kaltura_client.rb', line 3041 def partner_id @partner_id end |
#partner_sort_value ⇒ Object
Can be used to store various partner related data as a numeric value
3114 3115 3116 |
# File 'lib/kaltura_client.rb', line 3114 def partner_sort_value @partner_sort_value end |
#pending_entries_count ⇒ Object
Nunber of pending moderation entries
3129 3130 3131 |
# File 'lib/kaltura_client.rb', line 3129 def pending_entries_count @pending_entries_count end |
#pending_members_count ⇒ Object
Number of pending members for this category
3099 3100 3101 |
# File 'lib/kaltura_client.rb', line 3099 def pending_members_count @pending_members_count end |
#privacy ⇒ Object
defines the privacy of the entries that assigned to this category
3072 3073 3074 |
# File 'lib/kaltura_client.rb', line 3072 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.
3102 3103 3104 |
# File 'lib/kaltura_client.rb', line 3102 def privacy_context @privacy_context end |
#privacy_contexts ⇒ Object
comma separated parents that defines a privacyContext for search
3105 3106 3107 |
# File 'lib/kaltura_client.rb', line 3105 def privacy_contexts @privacy_contexts end |
#reference_id ⇒ Object
Category external id, controlled and managed by the partner.
3090 3091 3092 |
# File 'lib/kaltura_client.rb', line 3090 def reference_id @reference_id end |
#status ⇒ Object
Status
3108 3109 3110 |
# File 'lib/kaltura_client.rb', line 3108 def status @status end |
#tags ⇒ Object
Category tags
3066 3067 3068 |
# File 'lib/kaltura_client.rb', line 3066 def @tags end |
#updated_at ⇒ Object
Update date as Unix timestamp (In seconds)
3060 3061 3062 |
# File 'lib/kaltura_client.rb', line 3060 def updated_at @updated_at end |
#user_join_policy ⇒ Object
Who can ask to join this category
3078 3079 3080 |
# File 'lib/kaltura_client.rb', line 3078 def user_join_policy @user_join_policy end |