openedx.core.djangoapps.ace_common package

Subpackages

• openedx.core.djangoapps.ace_common.settings package
  • Submodules
  • openedx.core.djangoapps.ace_common.settings.common module
    • plugin_settings()
  • openedx.core.djangoapps.ace_common.settings.devstack module
    • plugin_settings()
  • openedx.core.djangoapps.ace_common.settings.production module
    • plugin_settings()
  • Module contents
• openedx.core.djangoapps.ace_common.templatetags package
  • Submodules
  • openedx.core.djangoapps.ace_common.templatetags.ace module
    • ensure_url_is_absolute()
    • google_analytics_tracking_pixel()
    • modify_url_to_track_clicks()
    • with_link_tracking()
  • Module contents

Submodules

openedx.core.djangoapps.ace_common.apps module

Configuration for the ace_common Django app.

class openedx.core.djangoapps.ace_common.apps.AceCommonConfig(app_name, app_module)

Bases: AppConfig

Configuration class for the ace_common Django app.

name = 'openedx.core.djangoapps.ace_common'

plugin_app = {'settings_config': {'cms.djangoapp': {'common': {'relative_path': 'settings.common'}, 'devstack': {'relative_path': 'settings.devstack'}, 'production': {'relative_path': 'settings.production'}}, 'lms.djangoapp': {'common': {'relative_path': 'settings.common'}, 'devstack': {'relative_path': 'settings.devstack'}, 'production': {'relative_path': 'settings.production'}}}}

verbose_name = 'ACE Common'

openedx.core.djangoapps.ace_common.message module

Base Message types to be used to construct ace messages.

class openedx.core.djangoapps.ace_common.message.BaseMessageType(*args, **kwargs)

Bases: MessageType

openedx.core.djangoapps.ace_common.policies module

Disable User Email OptOut Policy

class openedx.core.djangoapps.ace_common.policies.DisableUserOptout

Bases: Policy

Skips sending ace messages to disabled users

check(message)

Checks if the user is disabled and if so, skips sending the message

openedx.core.djangoapps.ace_common.template_context module

Context dictionary for templates that use the ace_common base template.

openedx.core.djangoapps.ace_common.template_context.get_base_template_context(site)

Dict with entries needed for all templates that use the base template.

openedx.core.djangoapps.ace_common.tracking module

class openedx.core.djangoapps.ace_common.tracking.CampaignTrackingInfo(source='ace', medium='email', campaign=None, term=None, content=None)

Bases: object

A struct for storing the set of UTM parameters that are recognized by tracking tools when included in URLs.

to_query_string(existing_query_string=None)

Generate a query string that includes the tracking parameters in addition to any existing parameters.

Note that any existing UTM parameters will be overridden by the values in this instance of CampaignTrackingInfo.

Parameters:

existing_query_string (str) – An existing query string that needs to be updated to include this tracking information.

Returns:

The URL encoded string that should be used as the query string in the URL.

Return type:

str

class openedx.core.djangoapps.ace_common.tracking.GoogleAnalyticsTrackingPixel(site=None, course_id=None, version=1, hit_type='event', campaign_source='ace', campaign_medium='email', campaign_name=None, campaign_content=None, event_category='email', event_action='edx.bi.email.opened', event_label=None, document_path=None, document_host=None, user_id=None, client_id=555)

Bases: object

Implementation of the Google Analytics measurement protocol for email tracking.

See this document for more info: https://developers.google.com/analytics/devguides/collection/protocol/v1/email

ANONYMOUS_USER_CLIENT_ID = 555

generate_image_url()

A URL to a clear image that can be embedded in HTML documents to track email open events.

The query string of this URL is used to capture data about the email and visitor.

openedx.core.djangoapps.ace_common.utils module

Utility functions for edx-ace.

openedx.core.djangoapps.ace_common.utils.setup_firebase_app(firebase_credentials, app_name='fcm-app')

Returns a Firebase app instance if the Firebase credentials are provided.

Module contents

# pylint: disable=django-not-configured ace_common is a Django App that provides common utilities and templates for edx-platform applications that use ACE as their messaging framework.