Python SDK for Khoros Communities

Welcome to the official documentation for the Python SDK for Khoros Communities.

Table of Contents

• Introduction
  • Installation
  • Change Log
  • Usage
    • Importing the package
    • Initializing a Khoros object instance
      • Passing the information directly into the object
      • Leveraging a “helper” configuration file
      • Utilizing environment variables
    • Interacting with the Community APIs
  • License
  • Reporting Issues
  • Roadmap
  • Additional Resources
  • Disclaimer
• Performing Community API Calls
  • Community API v1 calls
    • Performing a v1 GET request
    • Performing a v1 POST request
  • Community API v2 calls
    • Using LiQL queries and the query method
    • Passing search parameters to the search method
  • Generic API calls
    • Performing a GET request
    • Performing a POST request
    • Performing a PUT request
• Performing Bulk Data API Calls
  • Connecting to the API
    • During Instantiation
    • Using a Helper File
  • Querying the Bulk Data API
  • Manipulating Retrieved Data
    • Filtering by User Type
    • Filtering by Action
    • Counting Actions
    • Counting Logins and Views
• Working with Messages
  • Introduction
  • Prerequisites
    • Instantiation using environment variables
    • Instantiation using a helper file
    • Manual instantiation
  • Creating new messages
    • Defining the node
    • Identifying other parameters
      • Attachments
    • Calling the method
• Working with Boards
  • Overview
  • Creating a New Board
    • Return Options
      • Simple Boolean Response (Default)
      • Full API Response
      • Return the Board ID
      • Return the Board URL
      • Return the Board API URL
      • Return the API Response HTTP Code
      • Return the API Response Status
      • Return Any Error Messages
      • Return Multiple Types
    • Creating a New Forum
    • Creating a New Blog
    • Creating a New Tribal Knowledge Base (TKB)
    • Creating a New Q&A Board
    • Creating a New Idea Exchange
    • Creating a New Contest
    • Optional Configuration Items
      • Adding a Description
      • Defining the Parent Category
      • Creating a Hidden Board
      • Configuring Label Settings
  • Retrieving a Board ID
• Working with Group Hubs
  • Overview
  • Creating a New Group Hub
    • Return Options
      • Simple Boolean Response (Default)
      • Full API Response
      • Return the ID
      • Return the URL
      • Return the API URL
      • Return the API Response HTTP Code
      • Return the API Response Status
      • Return Any Error Messages
      • Return Multiple Types
    • Defining the ID and Title
• Managing Node Settings
  • Prerequisites
  • Retrieving node settings
    • Retrieving board settings
    • Retrieving category settings
    • Retrieving group hub settings
  • Defining node settings
  • Working with JSON strings
  • Troubleshooting
    • An unexpected error has occurred when defining a node setting
    • Unable to define node settings using the API v2 field name
    • No board with the specified dispid error
• Khoros Core Object
  • Init Module (khoros)
    • Khoros
      • Khoros.Album
        • Khoros.Album.__init__()
        • Khoros.Album.create()
        • Khoros.Album.get_albums_for_user()
      • Khoros.Archives
        • Khoros.Archives.__init__()
        • Khoros.Archives.aggregate_results()
        • Khoros.Archives.archive()
        • Khoros.Archives.is_archived()
        • Khoros.Archives.unarchive()
      • Khoros.Board
        • Khoros.Board.__init__()
        • Khoros.Board.board_exists()
        • Khoros.Board.create()
        • Khoros.Board.get_all_messages()
        • Khoros.Board.get_all_topic_messages()
        • Khoros.Board.get_board_id()
        • Khoros.Board.get_message_count()
        • Khoros.Board.structure_payload()
      • Khoros.BulkData
        • Khoros.BulkData.__init__()
        • Khoros.BulkData.count_actions()
        • Khoros.BulkData.count_logins()
        • Khoros.BulkData.count_views()
        • Khoros.BulkData.filter_anonymous()
        • Khoros.BulkData.filter_by_action()
        • Khoros.BulkData.get_base_url()
        • Khoros.BulkData.query()
      • Khoros.Category
        • Khoros.Category.__init__()
        • Khoros.Category.category_exists()
        • Khoros.Category.create()
        • Khoros.Category.friendly_date_enabled()
        • Khoros.Category.get_active_skin()
        • Khoros.Category.get_category_details()
        • Khoros.Category.get_category_field()
        • Khoros.Category.get_category_id()
        • Khoros.Category.get_creation_date()
        • Khoros.Category.get_depth()
        • Khoros.Category.get_description()
        • Khoros.Category.get_friendly_date_max_age()
        • Khoros.Category.get_language()
        • Khoros.Category.get_parent_id()
        • Khoros.Category.get_parent_type()
        • Khoros.Category.get_parent_url()
        • Khoros.Category.get_position()
        • Khoros.Category.get_root_id()
        • Khoros.Category.get_root_type()
        • Khoros.Category.get_root_url()
        • Khoros.Category.get_title()
        • Khoros.Category.get_total_category_count()
        • Khoros.Category.get_total_count()
        • Khoros.Category.get_url()
        • Khoros.Category.get_views()
        • Khoros.Category.is_hidden()
      • Khoros.Community
        • Khoros.Community.__init__()
        • Khoros.Community.email_confirmation_required_to_post()
        • Khoros.Community.friendly_date_enabled()
        • Khoros.Community.get_active_skin()
        • Khoros.Community.get_community_details()
        • Khoros.Community.get_community_field()
        • Khoros.Community.get_creation_date()
        • Khoros.Community.get_date_pattern()
        • Khoros.Community.get_description()
        • Khoros.Community.get_friendly_date_max_age()
        • Khoros.Community.get_language()
        • Khoros.Community.get_max_attachments()
        • Khoros.Community.get_ooyala_player_branding_id()
        • Khoros.Community.get_permitted_attachment_types()
        • Khoros.Community.get_primary_url()
        • Khoros.Community.get_sign_out_url()
        • Khoros.Community.get_tenant_id()
        • Khoros.Community.get_title()
        • Khoros.Community.show_breadcrumb_at_top_level()
        • Khoros.Community.show_community_node_in_breadcrumb()
        • Khoros.Community.sso_enabled()
        • Khoros.Community.top_level_categories_enabled()
        • Khoros.Community.top_level_categories_on_community_page()
      • Khoros.GroupHub
        • Khoros.GroupHub.__init__()
        • Khoros.GroupHub.create()
        • Khoros.GroupHub.get_total_count()
        • Khoros.GroupHub.grouphub_exists()
        • Khoros.GroupHub.structure_payload()
        • Khoros.GroupHub.update_title()
      • Khoros.Label
        • Khoros.Label.__init__()
        • Khoros.Label.get_labels_for_message()
      • Khoros.Message
        • Khoros.Message.__init__()
        • Khoros.Message.create()
        • Khoros.Message.define_context_id()
        • Khoros.Message.define_context_url()
        • Khoros.Message.flag()
        • Khoros.Message.format_content_mention()
        • Khoros.Message.format_user_mention()
        • Khoros.Message.get_all_messages()
        • Khoros.Message.get_all_topic_messages()
        • Khoros.Message.get_context_id()
        • Khoros.Message.get_context_url()
        • Khoros.Message.get_kudos_for_message()
        • Khoros.Message.get_metadata()
        • Khoros.Message.kudo()
        • Khoros.Message.label()
        • Khoros.Message.parse_v2_response()
        • Khoros.Message.tag()
        • Khoros.Message.unflag()
        • Khoros.Message.update()
        • Khoros.Message.validate_message_payload()
      • Khoros.Node
        • Khoros.Node.__init__()
        • Khoros.Node.get_avatar_url()
        • Khoros.Node.get_creation_date()
        • Khoros.Node.get_depth()
        • Khoros.Node.get_description()
        • Khoros.Node.get_discussion_style()
        • Khoros.Node.get_node_details()
        • Khoros.Node.get_node_field()
        • Khoros.Node.get_node_id()
        • Khoros.Node.get_node_type_from_url()
        • Khoros.Node.get_parent_id()
        • Khoros.Node.get_parent_type()
        • Khoros.Node.get_parent_url()
        • Khoros.Node.get_position()
        • Khoros.Node.get_root_id()
        • Khoros.Node.get_root_type()
        • Khoros.Node.get_root_url()
        • Khoros.Node.get_title()
        • Khoros.Node.get_total_node_count()
        • Khoros.Node.get_type()
        • Khoros.Node.get_url()
        • Khoros.Node.get_views()
        • Khoros.Node.is_hidden()
        • Khoros.Node.node_exists()
      • Khoros.Role
        • Khoros.Role.__init__()
        • Khoros.Role.assign_roles_to_user()
        • Khoros.Role.get_role_id()
        • Khoros.Role.get_roles_for_user()
        • Khoros.Role.get_total_role_count()
        • Khoros.Role.get_users_with_role()
      • Khoros.SAML
        • Khoros.SAML.__init__()
        • Khoros.SAML.import_assertion()
        • Khoros.SAML.send_assertion()
      • Khoros.Settings
        • Khoros.Settings.__init__()
        • Khoros.Settings.define_node_setting()
        • Khoros.Settings.get_node_setting()
      • Khoros.Studio
        • Khoros.Studio.__init__()
        • Khoros.Studio.get_node_version()
        • Khoros.Studio.get_npm_version()
        • Khoros.Studio.get_sdk_version()
        • Khoros.Studio.node_installed()
        • Khoros.Studio.npm_installed()
        • Khoros.Studio.sdk_installed()
      • Khoros.Subscription
        • Khoros.Subscription.__init__()
        • Khoros.Subscription.add_subscription()
        • Khoros.Subscription.get_subscription_uri()
        • Khoros.Subscription.subscribe_to_board()
        • Khoros.Subscription.subscribe_to_category()
        • Khoros.Subscription.subscribe_to_label()
        • Khoros.Subscription.subscribe_to_message()
        • Khoros.Subscription.subscribe_to_product()
      • Khoros.Tag
        • Khoros.Tag.__init__()
        • Khoros.Tag.add_single_tag_to_message()
        • Khoros.Tag.add_tags_to_message()
        • Khoros.Tag.get_tags_for_message()
        • Khoros.Tag.structure_single_tag_payload()
        • Khoros.Tag.structure_tags_for_message()
      • Khoros.User
        • Khoros.User.__init__()
        • Khoros.User.create()
        • Khoros.User.delete()
        • Khoros.User.get_album_count()
        • Khoros.User.get_all_users()
        • Khoros.User.get_all_users_count()
        • Khoros.User.get_email()
        • Khoros.User.get_followers_count()
        • Khoros.User.get_following_count()
        • Khoros.User.get_ids_from_login_list()
        • Khoros.User.get_images_count()
        • Khoros.User.get_kudos_given_count()
        • Khoros.User.get_kudos_received_count()
        • Khoros.User.get_last_visit_timestamp()
        • Khoros.User.get_login()
        • Khoros.User.get_messages_count()
        • Khoros.User.get_online_user_count()
        • Khoros.User.get_online_users_count()
        • Khoros.User.get_public_images_count()
        • Khoros.User.get_registered_users_count()
        • Khoros.User.get_registration_data()
        • Khoros.User.get_registration_status()
        • Khoros.User.get_registration_timestamp()
        • Khoros.User.get_replies_count()
        • Khoros.User.get_roles_count()
        • Khoros.User.get_solutions_authored_count()
        • Khoros.User.get_topics_count()
        • Khoros.User.get_user_data()
        • Khoros.User.get_user_id()
        • Khoros.User.get_username()
        • Khoros.User.get_users_count()
        • Khoros.User.get_videos_count()
        • Khoros.User.impersonate_user()
        • Khoros.User.query_users_table_by_id()
        • Khoros.User.update_sso_id()
      • Khoros.V1
        • Khoros.V1.__init__()
        • Khoros.V1.get()
        • Khoros.V1.post()
        • Khoros.V1.put()
        • Khoros.V1.search()
      • Khoros.V2
        • Khoros.V2.__init__()
        • Khoros.V2.get()
        • Khoros.V2.post()
        • Khoros.V2.put()
      • Khoros.__init__()
      • Khoros.close()
      • Khoros.connect()
      • Khoros.get()
      • Khoros.get_platform_version()
      • Khoros.get_session_key()
      • Khoros.get_total_count()
      • Khoros.parse_v2_response()
      • Khoros.perform_v1_search()
      • Khoros.post()
      • Khoros.put()
      • Khoros.query()
      • Khoros.search()
      • Khoros.signout()
  • Core Module (khoros.core)
    • Khoros
      • Khoros.Album
        • Khoros.Album.__init__()
        • Khoros.Album.create()
        • Khoros.Album.get_albums_for_user()
      • Khoros.Archives
        • Khoros.Archives.__init__()
        • Khoros.Archives.aggregate_results()
        • Khoros.Archives.archive()
        • Khoros.Archives.is_archived()
        • Khoros.Archives.unarchive()
      • Khoros.Board
        • Khoros.Board.__init__()
        • Khoros.Board.board_exists()
        • Khoros.Board.create()
        • Khoros.Board.get_all_messages()
        • Khoros.Board.get_all_topic_messages()
        • Khoros.Board.get_board_id()
        • Khoros.Board.get_message_count()
        • Khoros.Board.structure_payload()
      • Khoros.BulkData
        • Khoros.BulkData.__init__()
        • Khoros.BulkData.count_actions()
        • Khoros.BulkData.count_logins()
        • Khoros.BulkData.count_views()
        • Khoros.BulkData.filter_anonymous()
        • Khoros.BulkData.filter_by_action()
        • Khoros.BulkData.get_base_url()
        • Khoros.BulkData.query()
      • Khoros.Category
        • Khoros.Category.__init__()
        • Khoros.Category.category_exists()
        • Khoros.Category.create()
        • Khoros.Category.friendly_date_enabled()
        • Khoros.Category.get_active_skin()
        • Khoros.Category.get_category_details()
        • Khoros.Category.get_category_field()
        • Khoros.Category.get_category_id()
        • Khoros.Category.get_creation_date()
        • Khoros.Category.get_depth()
        • Khoros.Category.get_description()
        • Khoros.Category.get_friendly_date_max_age()
        • Khoros.Category.get_language()
        • Khoros.Category.get_parent_id()
        • Khoros.Category.get_parent_type()
        • Khoros.Category.get_parent_url()
        • Khoros.Category.get_position()
        • Khoros.Category.get_root_id()
        • Khoros.Category.get_root_type()
        • Khoros.Category.get_root_url()
        • Khoros.Category.get_title()
        • Khoros.Category.get_total_category_count()
        • Khoros.Category.get_total_count()
        • Khoros.Category.get_url()
        • Khoros.Category.get_views()
        • Khoros.Category.is_hidden()
      • Khoros.Community
        • Khoros.Community.__init__()
        • Khoros.Community.email_confirmation_required_to_post()
        • Khoros.Community.friendly_date_enabled()
        • Khoros.Community.get_active_skin()
        • Khoros.Community.get_community_details()
        • Khoros.Community.get_community_field()
        • Khoros.Community.get_creation_date()
        • Khoros.Community.get_date_pattern()
        • Khoros.Community.get_description()
        • Khoros.Community.get_friendly_date_max_age()
        • Khoros.Community.get_language()
        • Khoros.Community.get_max_attachments()
        • Khoros.Community.get_ooyala_player_branding_id()
        • Khoros.Community.get_permitted_attachment_types()
        • Khoros.Community.get_primary_url()
        • Khoros.Community.get_sign_out_url()
        • Khoros.Community.get_tenant_id()
        • Khoros.Community.get_title()
        • Khoros.Community.show_breadcrumb_at_top_level()
        • Khoros.Community.show_community_node_in_breadcrumb()
        • Khoros.Community.sso_enabled()
        • Khoros.Community.top_level_categories_enabled()
        • Khoros.Community.top_level_categories_on_community_page()
      • Khoros.GroupHub
        • Khoros.GroupHub.__init__()
        • Khoros.GroupHub.create()
        • Khoros.GroupHub.get_total_count()
        • Khoros.GroupHub.grouphub_exists()
        • Khoros.GroupHub.structure_payload()
        • Khoros.GroupHub.update_title()
      • Khoros.Label
        • Khoros.Label.__init__()
        • Khoros.Label.get_labels_for_message()
      • Khoros.Message
        • Khoros.Message.__init__()
        • Khoros.Message.create()
        • Khoros.Message.define_context_id()
        • Khoros.Message.define_context_url()
        • Khoros.Message.flag()
        • Khoros.Message.format_content_mention()
        • Khoros.Message.format_user_mention()
        • Khoros.Message.get_all_messages()
        • Khoros.Message.get_all_topic_messages()
        • Khoros.Message.get_context_id()
        • Khoros.Message.get_context_url()
        • Khoros.Message.get_kudos_for_message()
        • Khoros.Message.get_metadata()
        • Khoros.Message.kudo()
        • Khoros.Message.label()
        • Khoros.Message.parse_v2_response()
        • Khoros.Message.tag()
        • Khoros.Message.unflag()
        • Khoros.Message.update()
        • Khoros.Message.validate_message_payload()
      • Khoros.Node
        • Khoros.Node.__init__()
        • Khoros.Node.get_avatar_url()
        • Khoros.Node.get_creation_date()
        • Khoros.Node.get_depth()
        • Khoros.Node.get_description()
        • Khoros.Node.get_discussion_style()
        • Khoros.Node.get_node_details()
        • Khoros.Node.get_node_field()
        • Khoros.Node.get_node_id()
        • Khoros.Node.get_node_type_from_url()
        • Khoros.Node.get_parent_id()
        • Khoros.Node.get_parent_type()
        • Khoros.Node.get_parent_url()
        • Khoros.Node.get_position()
        • Khoros.Node.get_root_id()
        • Khoros.Node.get_root_type()
        • Khoros.Node.get_root_url()
        • Khoros.Node.get_title()
        • Khoros.Node.get_total_node_count()
        • Khoros.Node.get_type()
        • Khoros.Node.get_url()
        • Khoros.Node.get_views()
        • Khoros.Node.is_hidden()
        • Khoros.Node.node_exists()
      • Khoros.Role
        • Khoros.Role.__init__()
        • Khoros.Role.assign_roles_to_user()
        • Khoros.Role.get_role_id()
        • Khoros.Role.get_roles_for_user()
        • Khoros.Role.get_total_role_count()
        • Khoros.Role.get_users_with_role()
      • Khoros.SAML
        • Khoros.SAML.__init__()
        • Khoros.SAML.import_assertion()
        • Khoros.SAML.send_assertion()
      • Khoros.Settings
        • Khoros.Settings.__init__()
        • Khoros.Settings.define_node_setting()
        • Khoros.Settings.get_node_setting()
      • Khoros.Studio
        • Khoros.Studio.__init__()
        • Khoros.Studio.get_node_version()
        • Khoros.Studio.get_npm_version()
        • Khoros.Studio.get_sdk_version()
        • Khoros.Studio.node_installed()
        • Khoros.Studio.npm_installed()
        • Khoros.Studio.sdk_installed()
      • Khoros.Subscription
        • Khoros.Subscription.__init__()
        • Khoros.Subscription.add_subscription()
        • Khoros.Subscription.get_subscription_uri()
        • Khoros.Subscription.subscribe_to_board()
        • Khoros.Subscription.subscribe_to_category()
        • Khoros.Subscription.subscribe_to_label()
        • Khoros.Subscription.subscribe_to_message()
        • Khoros.Subscription.subscribe_to_product()
      • Khoros.Tag
        • Khoros.Tag.__init__()
        • Khoros.Tag.add_single_tag_to_message()
        • Khoros.Tag.add_tags_to_message()
        • Khoros.Tag.get_tags_for_message()
        • Khoros.Tag.structure_single_tag_payload()
        • Khoros.Tag.structure_tags_for_message()
      • Khoros.User
        • Khoros.User.__init__()
        • Khoros.User.create()
        • Khoros.User.delete()
        • Khoros.User.get_album_count()
        • Khoros.User.get_all_users()
        • Khoros.User.get_all_users_count()
        • Khoros.User.get_email()
        • Khoros.User.get_followers_count()
        • Khoros.User.get_following_count()
        • Khoros.User.get_ids_from_login_list()
        • Khoros.User.get_images_count()
        • Khoros.User.get_kudos_given_count()
        • Khoros.User.get_kudos_received_count()
        • Khoros.User.get_last_visit_timestamp()
        • Khoros.User.get_login()
        • Khoros.User.get_messages_count()
        • Khoros.User.get_online_user_count()
        • Khoros.User.get_online_users_count()
        • Khoros.User.get_public_images_count()
        • Khoros.User.get_registered_users_count()
        • Khoros.User.get_registration_data()
        • Khoros.User.get_registration_status()
        • Khoros.User.get_registration_timestamp()
        • Khoros.User.get_replies_count()
        • Khoros.User.get_roles_count()
        • Khoros.User.get_solutions_authored_count()
        • Khoros.User.get_topics_count()
        • Khoros.User.get_user_data()
        • Khoros.User.get_user_id()
        • Khoros.User.get_username()
        • Khoros.User.get_users_count()
        • Khoros.User.get_videos_count()
        • Khoros.User.impersonate_user()
        • Khoros.User.query_users_table_by_id()
        • Khoros.User.update_sso_id()
      • Khoros.V1
        • Khoros.V1.__init__()
        • Khoros.V1.get()
        • Khoros.V1.post()
        • Khoros.V1.put()
        • Khoros.V1.search()
      • Khoros.V2
        • Khoros.V2.__init__()
        • Khoros.V2.get()
        • Khoros.V2.post()
        • Khoros.V2.put()
      • Khoros.__init__()
      • Khoros.close()
      • Khoros.connect()
      • Khoros.get()
      • Khoros.get_platform_version()
      • Khoros.get_session_key()
      • Khoros.get_total_count()
      • Khoros.parse_v2_response()
      • Khoros.perform_v1_search()
      • Khoros.post()
      • Khoros.put()
      • Khoros.query()
      • Khoros.search()
      • Khoros.signout()
    • Core Functionality Subclasses (khoros.core.Khoros)
      • Studio Subclass (khoros.core.Khoros.Studio)
      • V1 Subclass (khoros.core.Khoros.V1)
    • Core Structure Subclasses (khoros.core.Khoros)
      • Board Subclass (khoros.core.Khoros.Board)
      • Category Subclass (khoros.core.Khoros.Category)
      • Community Subclass (khoros.core.Khoros.Community)
      • Group Hub Subclass (khoros.core.Khoros.GroupHub)
      • Node Subclass (khoros.core.Khoros.Node)
    • Core Object Subclasses (khoros.core.Khoros)
      • Album Subclass (khoros.core.Khoros.Album)
      • Archives Subclass (khoros.core.Khoros.Archives)
      • Message Subclass (khoros.core.Khoros.Message)
      • Role Subclass (khoros.core.Khoros.Role)
      • Settings Subclass (khoros.core.Khoros.Settings)
      • Subscription Subclass (khoros.core.Khoros.Subscription)
      • Tag Subclass (khoros.core.Khoros.Tag)
      • User Subclass (khoros.core.Khoros.User)
• Primary Modules
  • Init Module (khoros)
  • Core Module (khoros.core)
  • API Module (khoros.api)
    • combine_json_and_avatar_payload()
    • define_headers()
    • delete()
    • deliver_v2_results()
    • encode_multipart_data()
    • encode_payload_values()
    • encode_v1_query_string()
    • format_avatar_payload()
    • get_items_list()
    • get_platform_version()
    • get_request_with_retries()
    • get_results_count()
    • get_v1_node_collection()
    • get_v1_user_path()
    • make_v1_request()
    • parse_v2_response()
    • payload_request_with_retries()
    • perform_v1_search()
    • post_request_with_retries()
    • put_request_with_retries()
    • query_successful()
    • should_verify_tls()
  • Auth Module (khoros.auth)
    • get_oauth_authorization_url()
    • get_oauth_callback_url_from_user()
    • get_session_header()
    • get_session_key()
    • get_sso_key()
    • invalidate_session()
  • Bulk Data Module (khoros.bulk_data)
    • count_actions()
    • count_logins()
    • count_views()
    • filter_anonymous()
    • filter_by_action()
    • get_base_url()
    • query()
  • LiQL Module (khoros.liql)
    • LiQLSyntax
    • format_query()
    • get_query_url()
    • get_returned_items()
    • get_total_count()
    • parse_query_elements()
    • parse_select_fields()
    • parse_where_clause()
    • perform_query()
    • structure_cursor_clause()
  • Objects Module (khoros.objects)
    • Base Objects Module (khoros.objects.base)
      • Mapping
      • get_node_id()
      • get_node_type_from_url()
    • Albums Module (khoros.objects.albums)
      • create()
      • format_album_json()
      • get_albums_for_user()
    • Archives Module (khoros.objects.archives)
      • aggregate_results_data()
      • archive()
      • is_archived()
      • structure_archive_payload()
      • unarchive()
    • Attachments Module (khoros.objects.attachments)
      • construct_multipart_payload()
      • format_attachment_payload()
      • get_file_upload_info()
      • get_list_items()
    • Labels Module (khoros.objects.labels)
      • get_labels_for_message()
    • Messages Module (khoros.objects.messages)
      • construct_payload()
      • create()
      • define_context_id()
      • define_context_url()
      • flag()
      • format_content_mention()
      • format_user_mention()
      • get_all_messages()
      • get_all_topic_messages()
      • get_context_id()
      • get_context_url()
      • get_id_from_url()
      • get_kudos_for_message()
      • get_metadata()
      • is_read_only()
      • kudo()
      • label()
      • parse_v2_response()
      • set_read_only()
      • tag()
      • unflag()
      • update()
      • validate_message_payload()
    • Roles Module (khoros.objects.roles)
      • assign_roles_to_user()
      • count_role_types()
      • get_role_id()
      • get_roles_for_user()
      • get_total_role_count()
      • get_users_with_role()
    • Settings Module (khoros.objects.settings)
      • define_node_setting()
      • get_node_setting()
    • Subscriptions Module (khoros.objects.subscriptions)
      • add_subscription()
      • get_subscription_uri()
      • subscribe_to_board()
      • subscribe_to_category()
      • subscribe_to_label()
      • subscribe_to_message()
      • subscribe_to_product()
    • Tags Module (khoros.objects.tags)
      • add_single_tag_to_message()
      • add_tags_to_message()
      • get_tags_for_message()
      • structure_single_tag_payload()
      • structure_tags_for_message()
    • Users Module (khoros.objects.users)
      • ImpersonatedUser
        • ImpersonatedUser.close()
      • create()
      • delete()
      • get_album_count()
      • get_all_users()
      • get_all_users_count()
      • get_email()
      • get_followers_count()
      • get_following_count()
      • get_ids_from_login_list()
      • get_images_count()
      • get_kudos_given_count()
      • get_kudos_received_count()
      • get_last_visit_timestamp()
      • get_login()
      • get_messages_count()
      • get_online_user_count()
      • get_online_users_count()
      • get_public_images_count()
      • get_registered_users_count()
      • get_registration_data()
      • get_registration_status()
      • get_registration_timestamp()
      • get_replies_count()
      • get_roles_count()
      • get_solutions_authored_count()
      • get_topics_count()
      • get_user_data()
      • get_user_data_with_v1()
      • get_user_id()
      • get_username()
      • get_users_count()
      • get_videos_count()
      • impersonate_user()
      • process_user_settings()
      • query_users_table_by_id()
      • structure_payload()
      • structure_user_dict_list()
      • update_sso_id()
  • SAML Module (khoros.saml)
    • import_assertion()
    • send_assertion()
  • Structures Module (khoros.structures)
    • Base Structures Module (khoros.structures.base)
      • Mapping
      • get_details()
      • get_structure_field()
      • get_structure_id()
      • get_structure_type_from_url()
      • is_category_url()
      • is_node_url()
      • limit_to_first_child()
      • structure_exists()
      • verify_structure_type()
    • Boards Module (khoros.structures.boards)
      • board_exists()
      • create()
      • get_all_messages()
      • get_all_topic_messages()
      • get_board_id()
      • get_message_count()
      • structure_payload()
    • Categories Module (khoros.structures.categories)
      • category_exists()
      • create()
      • friendly_date_enabled()
      • get_active_skin()
      • get_category_details()
      • get_category_field()
      • get_category_id()
      • get_creation_date()
      • get_depth()
      • get_description()
      • get_friendly_date_max_age()
      • get_language()
      • get_parent_id()
      • get_parent_type()
      • get_parent_url()
      • get_position()
      • get_root_id()
      • get_root_type()
      • get_root_url()
      • get_title()
      • get_total_category_count()
      • get_total_count()
      • get_url()
      • get_views()
      • is_hidden()
    • Communities Module (khoros.structures.communities)
      • email_confirmation_required_to_post()
      • friendly_date_enabled()
      • get_active_skin()
      • get_community_details()
      • get_community_field()
      • get_creation_date()
      • get_date_pattern()
      • get_description()
      • get_friendly_date_max_age()
      • get_language()
      • get_max_attachments()
      • get_ooyala_player_branding_id()
      • get_permitted_attachment_types()
      • get_primary_url()
      • get_sign_out_url()
      • get_tenant_id()
      • get_title()
      • show_breadcrumb_at_top_level()
      • show_community_node_in_breadcrumb()
      • sso_enabled()
      • top_level_categories_enabled()
      • top_level_categories_on_community_page()
    • Group Hubs Module (khoros.structures.grouphubs)
      • create()
      • get_grouphub_id()
      • get_total_count()
      • grouphub_exists()
      • refresh_enabled_discussion_styles()
      • structure_payload()
      • update_title()
    • Nodes Module (khoros.structures.nodes)
      • Mapping
      • get_avatar_url()
      • get_creation_date()
      • get_depth()
      • get_description()
      • get_discussion_style()
      • get_node_details()
      • get_node_field()
      • get_node_id()
      • get_node_type_from_url()
      • get_parent_id()
      • get_parent_type()
      • get_parent_url()
      • get_position()
      • get_root_id()
      • get_root_type()
      • get_root_url()
      • get_title()
      • get_total_node_count()
      • get_type()
      • get_url()
      • get_views()
      • is_hidden()
      • node_exists()
  • Studio Module (khoros.studio)
    • Base Studio Module (khoros.studio.base)
      • get_node_version()
      • get_npm_version()
      • get_sdk_version()
      • node_installed()
      • npm_installed()
      • sdk_installed()
• Supporting Modules
  • Classes & Exceptions
    • Errors Module (khoros.errors)
      • Exceptions Module (khoros.errors.exceptions)
        • APIConnectionError
        • APIRequestError
        • CurrentlyUnsupportedError
        • DELETERequestError
        • DataMismatchError
        • FeatureNotConfiguredError
        • GETRequestError
        • HelperFunctionNotFoundError
        • InvalidCallbackURLError
        • InvalidEndpointError
        • InvalidFieldError
        • InvalidHelperArgumentsError
        • InvalidHelperFileTypeError
        • InvalidLookupTypeError
        • InvalidMessagePayloadError
        • InvalidMetadataError
        • InvalidNodeTypeError
        • InvalidOperatorError
        • InvalidParameterError
        • InvalidPayloadValueError
        • InvalidRequestTypeError
        • InvalidRoleError
        • InvalidRoleTypeError
        • InvalidStructureTypeError
        • InvalidURLError
        • KhorosError
        • LiQLParseError
        • LookupMismatchError
        • MessageTypeNotFoundError
        • MissingAuthDataError
        • MissingRequiredDataError
        • NodeIDNotFoundError
        • NodeTypeNotFoundError
        • NotFoundResponseError
        • OperatorMismatchError
        • POSTRequestError
        • PUTRequestError
        • PayloadMismatchError
        • SessionAuthenticationError
        • SsoAuthenticationError
        • TooManyResultsError
        • UnknownFileTypeError
        • UnsupportedNodeTypeError
        • UserCreationError
      • Handlers Module (khoros.errors.handlers)
        • eprint()
        • get_error_from_html()
        • get_error_from_json()
        • get_error_from_xml()
        • verify_core_object_present()
        • verify_v1_response()
      • Translations Module (khoros.errors.translations)
        • parse_message()
        • translate_error()
        • translation_enabled()
  • Tools & Utilities
    • Core Utilities Module (khoros.utils.core_utils)
      • convert_dict_id_values_to_strings()
      • convert_dict_list_to_simple_list()
      • convert_list_values()
      • convert_set()
      • convert_single_value_to_tuple()
      • convert_string_to_tuple()
      • decode_binary()
      • decode_html_entities()
      • display_warning()
      • encode_base64()
      • encode_query_string()
      • extract_key_values_from_dict_list()
      • get_file_type()
      • get_random_string()
      • is_iterable()
      • is_numeric()
      • merge_and_dedup()
      • remove_tld()
      • run_cmd()
      • url_decode()
      • url_encode()
    • Logging Utilities Module (khoros.utils.log_utils)
      • LessThanFilter
        • LessThanFilter.filter()
      • initialize_logging()
    • Environment Module (khoros.utils.environment)
      • get_env_variables()
      • update_env_variable_names()
    • Helper Module (khoros.utils.helper)
      • HelperParsing
      • get_helper_settings()
      • import_helper_file()
    • Version Module (khoros.utils.version)
      • get_full_version()
      • get_latest_stable()
      • get_major_minor_version()
      • latest_version()
      • log_current_version()
      • warn_when_not_latest()
  • Unit Testing
    • Tests Module (khoros.utils.tests)
      • Resources Module (khoros.utils.tests.resources)
        • MockResponse
        • control_data_exists()
        • get_control_data()
        • get_core_object()
        • get_structure_collection()
        • get_testing_config()
        • import_control_data()
        • import_modules()
        • initialize_khoros_object()
        • instantiate_with_local_helper()
        • instantiate_with_placeholder()
        • instantiate_with_secrets_helper()
        • local_helper_exists()
        • local_test_config_exists()
        • mock_bulk_data_json()
        • mock_error_post()
        • mock_success_post()
        • parse_testing_config_file()
        • secrets_helper_exists()
        • set_package_path()
      • Test Albums Module (khoros.utils.tests.test_albums)
        • set_package_path()
        • test_create_album()
        • test_failed_create_album()
      • Test Archives Module (khoros.utils.tests.test_archives)
        • set_package_path()
        • test_archive_check()
        • test_archive_content()
        • test_unarchive_content()
      • Test Board Creation Module (khoros.utils.tests.test_board_creation)
        • get_dict_for_required_fields()
        • get_required_fields()
        • test_description()
        • test_invalid_board_type()
        • test_no_arguments()
        • test_required_fields()
        • test_valid_board_types()
        • verify_data_fields()
      • Test Bulk Data Module (khoros.utils.tests.test_bulk_data)
        • test_base_url_without_helper()
        • test_bulk_data_query()
        • test_core_object_settings()
        • test_export_type_header()
        • test_valid_header_construction()
        • test_valid_parameter_construction()
      • Test Categories Module (khoros.utils.tests.test_categories)
        • set_package_path()
        • test_category_details()
        • test_create_category()
        • test_get_category_id()
        • test_if_category_exists()
        • test_total_count()
      • Test Communities Module (khoros.utils.tests.test_communities)
        • set_package_path()
        • test_community_details()
      • Test Core Utilities Module (khoros.utils.tests.test_core_utils)
        • import_core_utils()
        • set_package_path()
        • test_base64_conversions()
        • test_convert_set()
        • test_decode_binary()
        • test_display_warning()
        • test_html_entity_convert()
        • test_merge_and_dedup()
        • test_numeric_eval()
        • test_query_string_encoding()
        • test_remove_tld()
        • test_url_encoding()
      • Test Error Handling Module (khoros.utils.tests.test_error_handling)
        • test_eprint()
        • test_get_html_error()
        • test_parse_translation_error()
        • test_translate_error()
        • test_translation_check()
        • test_verify_core_object_present()
      • Test Exceptions Module (khoros.utils.tests.test_exceptions)
        • test_raising_exceptions()
      • Test Group Hub Creation Module (khoros.utils.tests.test_grouphub_creation)
        • test_no_arguments()
        • test_only_id()
        • verify_data_fields()
      • Test Helper File Module (khoros.utils.tests.test_helper_file)
        • get_helper_path()
        • set_package_path()
        • test_yaml_file()
      • Test HTTP Headers Module (khoros.utils.tests.test_http_headers)
        • compare_headers()
        • test_normalize_empty_headers()
        • test_normalize_headers()
        • test_normalize_type_error()
      • Test Library Import Module (khoros.utils.tests.test_library_import)
        • import_pkg_operation()
        • set_package_path()
        • test_library_import()
      • Test LiQL Module (khoros.utils.tests.test_liql)
        • parse_where_clauses()
        • perform_test_query()
        • set_package_path()
        • test_liql_query()
        • test_return_items_option()
        • test_where_clause_parsing()
      • Test Mentions Module (khoros.utils.tests.test_mentions)
        • expected_content_response()
        • expected_user_response()
        • get_content_test_data()
        • get_user_test_data()
        • set_package_path()
        • test_bad_content_url()
        • test_content_mention_with_all_arguments()
        • test_content_mention_with_false_id_arg()
        • test_content_mention_with_false_id_dict()
        • test_content_mention_with_full_dict()
        • test_content_mention_with_no_id_arg()
        • test_content_mention_with_no_id_dict()
        • test_relative_content_url_with_object()
        • test_relative_content_url_without_object()
        • test_user_mention_with_args_no_object()
        • test_user_mention_with_arguments()
        • test_user_mention_with_dict_and_object()
        • test_user_mention_with_dictionary()
        • test_user_mention_with_dictionary_no_object()
      • Test Messages Module (khoros.utils.tests.test_messages)
        • assert_tags_present()
        • get_control_data()
        • set_package_path()
        • test_construct_only_subject()
        • test_construct_with_body()
        • test_construct_with_node()
        • test_construct_with_node_id()
        • test_construct_with_node_url()
        • test_construct_with_one_int_tag()
        • test_construct_with_one_str_tag()
        • test_construct_with_str_iter_int_tags()
        • test_construct_with_str_iter_int_tags_ignore()
        • test_construct_with_tag_iterables()
        • test_count_messages()
        • test_flagging_message()
        • test_kudo_message()
        • test_label_message()
        • test_payload_validation()
        • test_tag_message()
      • Test Node ID Extract Module (khoros.utils.tests.test_node_id_extract)
        • get_test_data()
        • set_package_path()
        • test_url_without_node()
        • test_with_invalid_node_types()
        • test_with_only_url()
        • test_with_valid_node_types()
      • Test Roles Module (khoros.utils.tests.test_roles)
        • set_package_path()
        • test_get_role_id()
        • test_get_roles_for_user()
        • test_get_users_with_role()
        • test_invalid_role_type()
        • test_total_role_type_counts()
      • Test Settings Module (khoros.utils.tests.test_settings)
        • set_package_path()
        • test_invalid_node_type_exception()
        • test_node_setting_retrieval()
        • test_sso_status_retrieval()
      • Test SSL Verification Module (khoros.utils.tests.test_ssl_verify)
        • test_api_global_variable_assignment()
        • test_api_should_verify_function()
        • test_core_object_with_param_setting()
        • test_default_core_object_setting()
      • Test Studio Module (khoros.utils.tests.test_studio)
        • test_studio_functions()
      • Test Tags Module (khoros.utils.tests.test_tags)
        • get_structure_control_data()
        • test_add_single_tag_to_message()
        • test_failed_add_single_tag_to_message()
        • test_invalid_payload_for_single_tag()
        • test_message_structure_one_string_tag_ignore()
        • test_message_structure_one_tag()
        • test_message_structure_str_int()
        • test_message_structure_str_int_ignore()
        • test_message_structure_two_string_tags_ignore()
        • test_message_structure_two_tags()
        • test_single_tag_structure()
      • Test Users Module (khoros.utils.tests.test_users)
        • set_package_path()
        • test_create_user()
        • test_failed_create_user()
        • test_get_counts()
        • test_get_user_identifiers()
        • test_impersonate_user()
        • test_unsupported_update_sso_id()
        • test_users_table_query()
      • Test Version Module (khoros.utils.tests.test_version)
        • test_full_version()
        • test_latest_stable()
        • test_latest_version()
        • test_major_minor_version()

• Change Log
  • v5.4.0
  • v5.3.0
  • v5.2.2
  • v5.2.1
  • v5.2.0
  • v5.1.3
  • v5.1.2
  • v5.1.1
  • v5.1.0
  • v5.0.0
  • v4.5.0
  • v4.4.0
  • v4.3.0.post1
  • v4.3.0
  • v4.2.1
  • v4.2.0
  • v4.1.1
  • v4.1.0
  • v4.0.0
  • v3.5.0
  • v3.4.0
  • v3.3.3
  • v3.3.2
  • v3.3.1
  • v3.3.0
  • v3.2.0
  • v3.1.1
  • v3.1.0
  • v3.0.0
  • v2.8.0
  • v2.7.6
  • v2.7.5
  • v2.7.4
  • v2.7.3
  • v2.7.2
  • v2.7.1
  • v2.7.0
  • v2.6.0
  • v2.5.2
  • v2.5.1
  • v2.5.0
  • v2.4.0
  • v2.3.0
  • v2.2.0
  • v2.1.0
  • v2.0.0
  • v1.2.0
  • v1.1.0

Module Index and Search

• Index

• Module Index

• Search Page