Sunbird Content Specification for Bazaar Apps

Approach 1 : (Deeper Integration)

Intent provides basic information such as content do_id, telemetry context information.

Targeted Application need to fetch the data from platform. Understand the Content Metadata and play the content.

Targeted Application need to respond back with Summary Data

Pros

It can enable bazaar apps to index the content in their own environment.

It could open up the Sunbird APIs for most of the bazaar players.

Cons

Data to be sent might be huge

Spec is rigid. If the spec changes there can be inconsistency between various version of both apps

Approach 2 : (Lighter Integration)

Intent provides basic information such as content do_id, context information & artifactUrl and mimeType.

Bazaar Apps can launch the artifactUrl directly based on mimeType.

Pros
Least Effort in integrating the Intent for bazaar apps.

Need to develop a secure mechanism to serve only sun bird specific resources.

Cons

Data to be sent might be huge

Spec is rigid. If the spec changes there can be inconsistency between various version of both apps

Intent provides the basic information such as content URL, mimeType & user/session context.

Pros

1. The spec doesn’t need to change if more content metadata needs to be sent

2. The integration apps need to understand our content model and can also index the content in their apps

Context Information

Following are the contextual params passed to the reader app

1. Device ID

2. User ID

3. Session ID

4. Collection ID

5. Batch ID

6. Reference ID
   

https://github.com/sunbird-specs/Telemetry/blob/main/v3_event_details.md/#summary

{
  "edata": {
    "type": "", // Required. Type of summary. Free text. "session", "app", "tool" etc
    "mode": "", // Optional.
    "starttime": Long, // Required. Epoch Timestamp of app start. Retrieved from first event.
    "endtime": Long, // Required. Epoch Timestamp of app end. Retrieved from last event.
    "timespent": Double, // Required. Total time spent by visitor on app in seconds excluding idle time.
    "pageviews": Long, // Required. Total page views per session(count of CP_IMPRESSION)
    "interactions": Long, // Required. Count of interact events
    "envsummary": [{ // Optional
        "env": String, // High level env within the app (content, domain, resources, community)
        "timespent": Double, // Time spent per env
        "visits": Long // count of times the environment has been visited
    }],
    "eventssummary": [{ // Optional
        "id": String, // event id such as CE_START, CE_END, CP_INTERACT etc.
        "count": Long // Count of events.
    }],
    "pagesummary": [{ // Optional
        "id": String, // Page id
        "type": String, // type of page - view/edit
        "env": String, // env of page
        "timespent": Double, // Time taken per page
        "visits": Long // Number of times each page was visited
    }]
  }
}

All the reader apps need to send summary data back to Sunbird app via intent data.

The third party apps should do a HTTP GET call on the contentUrl parameter sent via the intent data

GET intentdata.contentUrl

Headers {
  X-App-ID: <ID of the App>,
  X-App-Version: <Version of the App>,
  X-Device-ID: <Device Id>
}

Response Data Structure

{
  "id":"api.content.read",
  "ver":"v1",
  "ts":"2021-02-10 04:27:14:674+0000",
  "params":{
    "resmsgid":null,
    "msgid":"90e184d1-c52c-106b-c410-6a168900ef05",
    "err":null,
    "status":"success",
    "errmsg":null
  },
  "responseCode":"OK",
  "result": {
    "content": ContentModel
  }
}

For More Details on the content model refer Sunbird Documentation
Object Types

Intent Handling

• Need to implement an activity which is capable of calling API and read the content metadata to launch the content in their respective apps. Following is the API request,response structure to be adhered to.

• Need to create an intent filter in Android Manifest as follows :

• <activity
      android:name="com.example.ExampleActivity"
      android:label="@string/title_example" >
      <intent-filter android:label="@string/play_view_web_example">
          <action android:name="android.intent.action.VIEW" />
          <category android:name="android.intent.category.DEFAULT" />
          <category android:name="android.intent.category.BROWSABLE" />
          <!-- Accepts URIs that begin with "http://sunbird.staginged.in/play” -->
          <data android:scheme="https"
                android:host="sunbird.staginged.in"
                android:pathPrefix="/play" />
      </intent-filter>
      <intent-filter android:label="@string/play_view_app_example">
          <action android:name="android.intent.action.VIEW" />
          <category android:name="android.intent.category.DEFAULT" />
          <category android:name="android.intent.category.BROWSABLE" />
          <!-- Accepts URIs that begin with "example://play” -->
          <data android:scheme="example"
                android:host="play" />
      </intent-filter>
  </activity>

  
  Implement Activity as follows

• @Override
  public void onCreate(Bundle savedInstanceState) {
      super.onCreate(savedInstanceState);
      setContentView(R.layout.main);
  
      Intent intent = getIntent();
      String action = intent.getAction();
      Uri data = intent.getData();
      <!-- Trigger the Business Logic of App -->
  }