lms.djangoapps.user_tours package

lms.djangoapps.user_tours package#

Subpackages#

Submodules#

lms.djangoapps.user_tours.apps module#

User Tour application configuration.

class lms.djangoapps.user_tours.apps.UserTourConfig(app_name, app_module)#

Bases: AppConfig

User Tour application configuration.

name = 'lms.djangoapps.user_tours'#

ready()#: Code to run when getting the app ready.

lms.djangoapps.user_tours.handlers module#

Signal handlers for User Tours.

lms.djangoapps.user_tours.handlers.init_user_tour(sender, instance, created, **kwargs)#: Initialize a new User Tour when a new user is created.

lms.djangoapps.user_tours.models module#

Models for the User Tour Experience.

class lms.djangoapps.user_tours.models.UserDiscussionsTours(*args, **kwargs)#

Bases: Model

Model to track which discussions tours a user has seen.

exception DoesNotExist#: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned#: Bases: MultipleObjectsReturned

id#: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>#

show_tour#: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

tour_name#: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

user#

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

user_id#

class lms.djangoapps.user_tours.models.UserTour(*args, **kwargs)#

Bases: Model

Model to track which tours a user needs to be shown.

Note: This does not track which tours a user has seen, only the ones they should.

class CourseHomeChoices(*values)#

Bases: TextChoices

EXISTING_USER_TOUR = 'show-existing-user-tour'#

NEW_USER_TOUR = 'show-new-user-tour'#

NO_TOUR = 'no-tour'#

exception DoesNotExist#: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned#: Bases: MultipleObjectsReturned

course_home_tour_status#: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_course_home_tour_status_display(*, field=<django.db.models.fields.CharField: course_home_tour_status>)#

id#: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>#

show_courseware_tour#: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

user#

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

user_id#

lms.djangoapps.user_tours.toggles module#

Toggles for the User Tours Experience.

lms.djangoapps.user_tours.urls module#

URLs for User Tours.