Khoros JX Python Library¶
Welcome to the official documentation for the Khoros JX Python Library.
Table of Contents¶
- Introduction
- Core Functionality
- Using the Helper Utility
- Managing Users
- Primary Modules
- Init Module (khorosjx)
- Core Module (khorosjx.core)
connect()
delete()
ensure_absolute_url()
get_api_info()
get_api_version()
get_base_url()
get_connection_info()
get_data()
get_fields_from_api_response()
get_paginated_results()
get_platform_version()
get_query_url()
get_request_with_retries()
post_request_with_retries()
put_request_with_retries()
set_base_url()
set_credentials()
verify_connection()
- Admin Module (khorosjx.admin)
- Content Module (khorosjx.content)
get_content_id()
get_document_attachments()
get_document_info()
overwrite_doc_body()
- Base Content Module (khorosjx.content.base)
- Documents Module (khorosjx.content.docs)
- Events Module (khorosjx.content.events)
- Ideas Module (khorosjx.content.ideas)
- Threads Module (khorosjx.content.threads)
- Videos Module (khorosjx.content.videos)
- Groups Module (khorosjx.groups)
- News Module (khorosjx.news)
delete_publication()
delete_stream()
filter_subscriptions_by_id()
get_all_publications()
get_publication()
get_stream()
get_subscriber_groups()
get_subscriber_ids()
get_subscribers()
get_subscription_data()
get_subscription_ids()
rebuild_publication()
retrieve_connection_info()
update_publication()
update_stream()
verify_core_connection()
- Places Module (khorosjx.places)
- Spaces Module (khorosjx.spaces)
- Users Module (khorosjx.users)
- Supporting Modules
- Tools and Utilities
- Classes and Exceptions
- Classes Module (khorosjx.utils.classes)
- Errors Module (khorosjx.errors)
- Exceptions Module (khorosjx.errors.exceptions)
APIConnectionError
BadCredentialsError
ContentNotFoundError
ContentPublishError
CredentialsUnpackingError
CurrentlyUnsupportedError
DatasetNotFoundError
GETRequestError
HelperFunctionNotFoundError
IncompleteCredentialsError
InvalidDatasetError
InvalidEndpointError
InvalidFileTypeError
InvalidHelperArgumentsError
InvalidKhorosJXModuleError
InvalidLookupTypeError
InvalidRequestTypeError
InvalidScopeError
KhorosJXError
LookupMismatchError
MissingBaseUrlError
NoCredentialsError
NotFoundResponseError
POSTRequestError
PUTRequestError
SpaceNotFoundError
SubscriptionNotFoundError
UserNotFoundError
UserQueryError
WrongCredentialTypeError
- Handlers Module (khorosjx.errors.handlers)
- Exceptions Module (khorosjx.errors.exceptions)