API Docs for:
Show:

eb_eventCatalog Class

Event Catalog class.

Methods

eb_eventCatalog.domElement

(
  • domElement
)

Page DOM element.

Parameters:

  • domElement Object

    current DOM element.

eb_eventCatalog.eventModel

(
  • data
)

Event product model. Converts event object into knockout model.

Parameters:

  • data Object

    Event object.

eb_eventCatalog.fieldsToSearch

() Object

List of event product properties on which search is applied.

Returns:

Object:

Array of event product name property.

eb_eventCatalog.getEvents

() Object

Get events data from the server through the get service call. The service will return list of all events.

Returns:

Object:

jQuery promise object which when resolved returns list of all events.

eb_eventCatalog.getMyEvents

(
  • url
)
Object

Get events to which user has registered from the server through the get service call. The service will return list of all events to which logged-in user is registered.

Parameters:

  • url String

    URL for my-events service.

Returns:

Object:

jQuery promise object which when resolved returns list of all events to which logged-in user is registered.

eb_eventCatalog.model

(
  • options
)

Event catalog model responsible to all event catalog operations.

Parameters:

  • options Any

    Object of event catalog data.

    • ServicePath String

      Service URL.

    • SitePath String

      Site URL.

    • templatePath String

      HTML path.

    • currentUserLoggedInID: String

      User Linked ID.

    • domElement Object

      Event catalog DOM element.

    • data Object

      List of all events.

    • shoppingCart Object

      eb_shoppingCart.shoppingCartModel instance.

eb_eventCatalog.pagerModel

(
  • records
)

Pagination model. Contains computed functions that get invoked when page size change or page navigation.

Parameters:

  • records Object

    Events list.

eb_eventCatalog.render

(
  • options
)
String

The service will return event catalog HTML. Template path and DOM element are required parameters.

Parameters:

  • options Any

    Array of required data.

    • templatePath String

      Events catalog template URL.

Returns:

String:

jQuery promise object which when resolved returns HTML template.

eb_eventCatalog.searchRecords

(
  • toSearch
  • fields
  • eventsList
)

Events search function.

Parameters:

  • toSearch String

    Value entered in search text-box field.

  • fields Object

    Array of event product properties on which search will be performed.

  • eventsList Object

    List of events models.

eb_eventCatalog.shoppingCart

(
  • shoppingCart
)

Global function to hold shopping cart object.

Parameters:

  • shoppingCart Object

    Instance of eb_shoppingCart.shoppingCartModel.

Properties

eb_eventCatalog.defaultImage

String

Default image URL. If event photo is not available, default image will be shown.

eb_eventCatalog.getAllEventsService

String

Service path to get all events.

eb_eventCatalog.getMyEventsURL

String

Service path to get all events which is registered by logged-in user.

eb_eventCatalog.productDetailsURL

String

Site path to get event details.

eb_eventCatalog.ServicePath

String

SOA path.

eb_eventCatalog.SitePath

String

Site path. It would be set from configuration file.

eb_eventCatalog.TemplatePath

String

Event catalog template path.