A library that gives you access to Orchextra Content platform from your Android device.

Start by creating a project in Orchextra Dashboard, if you haven't done it yet. Go to "Setting" > "SDK Configuration" to get the api key and api secret, you will need these values to start Orchextra SDK.

You can check how SDK works with the :app module of this repository.

Orchextra can be integrated in Ice Cream Sandwich (v. 14) or later.

We have to add the gradle dependencies. In our rootproject build.gradle file, we add the following maven dependency. This is required in order to advice gradle that it has to look for Orchextra sdk inside jitpack.io maven repository. Gradle file is this one:

allprojects {
    repositories {
        jcenter()
        maven { url "https://jitpack.io" }
        maven { url "https://repo.leanplum.com/" }
    }
}

Then we have to add the following dependency into the build.gradle module:

   compile 'com.github.Orchextra:orchextra-content-android-sdk:LAST_VERSION'

and we must sync gradle project.

NOTE: You can check the last version of this library in the 'Releases' tab and substitute the LAST_VERSION reference with the last library version.

We have to created a class which extends from Application (if we didn't do yet) and add the Orchextra Content init method.

OcmBuilder ocmBuilder =
        new OcmBuilder(this)
        .setOrchextraCredentials(API_KEY, API_SECRET)
        .setOnDoRequiredLoginCallback(doRequiredLoginCallback)
        .setOnEventCallback(eventCallback)
        .setOnCustomSchemeReceiver(onCustomSchemeReceiver)
        .setContentLanguage(getContentLanguage())
        .setNotificationActivityClass(MainActivity.class);
        
Ocm.initialize(ocmBuilder);

IMPORTANT you must make this call in public void onCreate() of your Application class, if you do not call initialize in this method, the SDK will not initialize properly. You can check that using the logLevel.

IMPORTANT if you are using Android Studio 2.1 or higher, and have "Instant Run" enabled, the first time you install the APK is installed in new device, the initialize() spends too much time, maybe a minute on older devices. The second time the problem disappears. To avoid this problem in Android Studio, disables the " Instant Run" from settings-> Build , Execution , Deployment- > Instant Run

Then, in any part of our application we should start the library sdk.

Ocm.start();

If we doesn't set the new credentials when we initialize the sdk, or change them with new ones. We can set them in any moment during the application life.

Ocm.startWithCredentials(NEW_API_KEY,NEW_API_SECRET, callback);

The callback returns the new access token credential. If the credentials have no change, the method do nothing.

Some content of the app is blocked and the user, who use the app, needs to be logged. The setOnDoRequiredLoginCallback method is a listener that is executed when the library needs that the user is logged in the app. The integrative application must execute the login flow and communicate to the sdk that the user is logged in with the following method. If user is log out from the app, we have to execute this method as well.

Ocm.setUserIsAuthorizated(true);

The setOnEventCallback method receive some values only for analytics usage. This callback is executed when the user do some actions with the app.

• SHARE: When a content is shared.
• CONTENT_START: When a content is showed.

 private OnEventCallback eventCallback = new OnEventCallback() {
    @Override public void doEvent(OcmEvent event, Object data) {
      switch (event) {
        case SHARE:
          break;
        case CONTENT_START:
          break;
        case CONTENT_END:
          break;
      }
    }
  };
  OcmBuilder ocmBuilder = new OcmBuilder(this).setOnEventCallback(eventCallback);

The setOnCustomSchemeReceiver setOnCustomSchemeReceiver execute the custom schemes that the library receives.

 private CustomSchemeReceiver onCustomSchemeReceiver = new CustomSchemeReceiver() {
    @Override public void onReceive(String deepLink) {
    }
  };
  OcmBuilder ocmBuilder = new OcmBuilder(this).setOnCustomSchemeReceiver(onCustomSchemeReceiver);

Set the content language of the sdk with setContentLanguage method.

  OcmBuilder ocmBuilder = new OcmBuilder(this).setContentLanguage("EN");

You can set the main activity to execute the sdk notification.

  OcmBuilder ocmBuilder = new OcmBuilder(this).setNotificationActivityClass(MainActivity.class);

You can set the style sdk with the following class.

OcmStyleUiBuilder ocmStyleUiBuilder =
        new OcmStyleUiBuilder().setTitleFontAssetsPath("fonts/Gotham-Ultra.ttf")
            .setNormalFont("fonts/Gotham-Book.ttf")
            .setMediumFont("fonts/Gotham-Medium.ttf")
            .setLightFont("fonts/Gotham-Light.ttf");
    Ocm.setStyleUi(ocmStyleUiBuilder);

Ocm.setBusinessUnit("it");

You can retrieve the menu of your content project with the following method. The UiMenu class has the info to show the app menu.

Ocm.getMenus(new OnRetrieveUiMenuListener() {
      @Override public void onResult(final List<UiMenu> uiMenu) {
      }

      @Override public void onNoNetworkConnectionError() {
      }

      @Override public void onResponseDataError() {
      }
    });

When you retrieve the menu info, you can load the data from the each menu with the following method. The UiGridBaseContentData class is a fragment, which you can add to some activity.

    UiGridBaseContentData uiGridBaseContentData =
        Ocm.generateGridView(uiMenu.get(position).getElementUrl(), filter);
        
    getSupportFragmentManager().beginTransaction()
        .replace(R.id.contentLayout, uiGridBaseContentData)
        .commit();

We can open some detail view with the element url provided for some custom scheme.

UiDetailBaseContentData uiDetailBaseContentData = Ocm.generateDetailView(uiMenu.get(position).getElementUrl());

We can open the search view to do search of the content.

UiSearchBaseContentData uiSearchBaseContentData = Ocm.generateSearchView();

When the app is opened with some deep link, we can provide this deep link to the sdk with the following method. The sdk will do some action, if the deep link is configured in the dashboard.

Ocm.processDeepLinks("some/deep/link");

We can provide a string pair list, which have the configuration for web and login views.

Ocm.setLocalStorage(new HashMap<String, String>());

We can define a specific custom user.

CrmUser crmUser = new CrmUser("crmId", new GregorianCalendar(1981, Calendar.MAY, 31), CrmUser.Gender.GenderMale);
Ocm.bindUser(crmUser);

With this method we can clear all sdk cache. Next content data request will update all sdk data.

Ocm.clearCache();

  <color name="oc_button_color_pressed">#DFFF</color>
  <color name="oc_button_color">#FFF</color>

  <!-- More content -->
  <color name="oc_background_more_content_layout">#807f7f</color>
  <color name="oc_more_content_text_color">#FFF</color>
  <color name="oc_more_content_button_text_color">#807f7f</color>

  <!-- Retry -->
  <color name="oc_background_retry_content_layout">#807f7f</color>
  <color name="oc_retry_content_text1_color">#FFF</color>
  <color name="oc_retry_content_text2_color">#FFF</color>
  <color name="oc_retry_content_button_text_color">#807f7f</color>

  <!-- Detail -->
  <color name="oc_article_rich_text_color">#474747</color>
  <color name="oc_article_header_title_text_color">#4a4a4a</color>
  <color name="oc_preview_title_text_color">#FFF</color>
  <color name="oc_preview_down_arrow_tint_color">#FFF</color>
  <color name="oc_preview_down_arrow_text_color">#9FFF</color>

  <color name="oc_youtube_layout_container_color">#000</color>

  <!-- Grid -->
  <color name="oc_padlock_gradient_start">#807f7f</color>
  <color name="oc_padlock_gradient_end">#807f7f</color>
  <color name="oc_background_grid_color">#807f7f</color>
  <color name="oc_background_search_grid_color">#807f7f</color>

  <color name="oc_bg_article_header_color">#FFF</color>
  <color name="oc_bg_article_image_color">#FFF</color>
  <color name="oc_bg_article_rich_text_color">#FFF</color>
  <color name="oc_bg_article_video_color">#FFF</color>
  <color name="oc_bg_article_content_color">#FFF</color>

  <color name="oc_bg_dialog_applivery_color">#FFF</color>

  <color name="oc_progress_webview_color">#FFF</color>

  <color name="oc_bg_blank_item_multiple_grid_color">#807f7f</color>

  <string name="oc_retry_content_button_text">RETRY</string>

  <string name="oc_retry_content_text1">Ups!</string>
  <string name="oc_retry_content_text2">We have a mistake</string>

  <string name="oc_more_content_text1">Do you like similar content?</string>
  <string name="oc_more_content_text2">""</string>
  <string name="oc_more_content_button_text">DISCOVER MORE</string>

  <string name="oc_preview_down_arrow_text">SLIDE DOWN</string>

  <dimen name="oc_spacing_8">8dp</dimen>
  <dimen name="oc_spacing_16">16dp</dimen>
  <dimen name="oc_spacing_32">32dp</dimen>
  <dimen name="oc_spacing_64">64dp</dimen>

  <dimen name="oc_text_14">14sp</dimen>
  <dimen name="oc_text_24">24sp</dimen>
  <dimen name="oc_text_30">30sp</dimen>

  <dimen name="oc_more_content_text1_size">20sp</dimen>
  <dimen name="oc_more_content_text2_size">20sp</dimen>
  <dimen name="oc_more_content_text_button_size">14sp</dimen>

  <dimen name="oc_retry_content_text1_size">40sp</dimen>
  <dimen name="oc_retry_content_text2_size">20sp</dimen>
  <dimen name="oc_retry_content_button_size">14sp</dimen>

  <dimen name="oc_preview_down_arrow_text_size">14sp</dimen>

  <dimen name="oc_button_size">65dp</dimen>