Creating personalized cross platform mobile apps with the Sitecore Mobile SDK
1 like1,472 views
The document provides a comprehensive guide on the use of the Sitecore Mobile SDK for creating cross-platform apps using Xamarin and .NET tools. It covers the different functionalities and configurations of the SDK, including item retrieval, updates, deletions, and media handling, as well as session management and request building methods. It emphasizes the advantages of using the SDK for efficient mobile content delivery and provides examples for various operations within the framework.
Creating personalized cross platform mobile apps with the Sitecore Mobile SDK
- 1. Use the mobile SDK to create personalized cross-platform apps leveraging the xDB Presented by // Mark vanAalst 12 june 2015
- 2. Sitecore Mobile SDK Family Mobile SDK for Xamarin Mobile SDK for .NET Mobile SDK for iOS Mobile SDK for Android
- 3. Sitecore Mobile SDK for Xamarin Powered by the Mobile SDK for .NET portable class library (PCL) Currently consistent features Single package on NuGet Xamarin SDK expected to grow
- 4. Sitecore Mobile SDKs for mobile content delivery Manage in-app content directly from Sitecore Content marketing and updates without the traditional app update process Sitecore provides the client/serverAPIs, you provide the app One JSON REST-like web services server API – ItemWeb API Many native web service clients Clients de-serialize JSON (JavaScript) into strongly typed objects Asynchronous -Thread friendly / non-blocking
- 7. Build native iOS and Android apps inVisual Studio Write C#. Run on 2.6 billion devices Share Code and UI Use NuGet and the Xamarin Component Store Xamarin Advantages
- 8. Where does the SDK fit in? 8 Sitecore Mobile SDK for XamarinShared C# App Logic Platform Specific C# Platform Specific C#Platform Specific C#
- 9. Diving into the Mobile SDK 9
- 10. 10 What is the SDK ItemWebAPI Request Builder WebApiRequest ScApiSession Sitecore MobileC# SDK Item Objects Response HTTP Request HTTP Response Item Objects Request
- 11. Advantages Build requests using native methods Wraps ItemWebAPI requests Deserializes response in to strong typed objects
- 12. Setting up a session 12 Use SitecoreWebApiSessionBuilder class Security • Anonymous Session • Authenticated Session Permissions • Read-only • Read/Write Endpoint • Instance URL • Credentials • Context Site • Wep API version Item Source • Default Database • Default Language Media Library Parameters • Media Root item • Media Prefix • Default Extension • Resizing strategy var session =SitecoreWebApiSessionBuilder.AuthenticatedSessionWithHost(“http://my-host.com”) .Credentials(loginAndPasswordProvider) .Site("/sitecore/shell") .WebApiVersion("v1") .DefaultDatabase("web") .DefaultLanguage("en") .MediaLibraryRoot("/sitecore/media library") .MediaPrefix("~/media/") .DefaultMediaResourceExtension("ashx") .MediaResizingStrategy(DownloadStrategy.Plain) .BuildSession();
- 13. Building sessions 13 The Mobile SDK provides the following builder methods: BuildReadonlySession() BuildSession() Warning: If you use a read-only session but your code contains methods that change/create content, the application will not compile. SitecoreWebApiSessionBuilder.AnonymousSessionWithHost(“http://my-host.com”).BuildReadonlySession(); SitecoreWebApiSessionBuilder.AnonymousSessionWithHost(“http://my-host.com”).BuildSession();
- 14. Configuring your request 14 • Create, Read, Update and Delete functionality • RequestBuilder syntax is the same, scope may vary The Mobile SDK provides a set of methods to define the following properties: Database Language Version Payload Fields Scope Paging
- 15. Usage Configure the database to get items from Mobile SDK method: Database(string) ItemWeb API param: sc_database Optional: Yes Item Request Parameters - Database 15 Database Language Version Payload Fields Scope Paging
- 16. Usage Define the item language Mobile SDK method: Language(string) ItemWeb API param: language Optional: Yes Item Request Parameters - Language 16 Database Language Version Payload Fields Scope Paging
- 17. Usage Define the specific version. Do not invoke for the latest version Mobile SDK method: Version(int?) ItemWeb API param: sc_itemversion Optional: Yes Item Request Parameters -Version 17 Database Language Version Payload Fields Scope Paging
- 18. Usage Use payload type enumerator (content, default, full, min) to define the field list returned Mobile SDK method: Payload(PayloadType) ItemWeb API param: payload Optional: Yes Item Request Parameters - Payload 18 Database Language Version Payload Fields Scope Paging
- 19. Usage Use as an alternative for payload. Set the fields returned explicitly. Mobile SDK method: AddFieldsToRead(string), AddFieldsToRead(Ilist<string>) ItemWeb API param: fields Optional: Yes Item Request Parameters - Fields 19 Database Language Version Payload Fields Scope Paging
- 20. Usage Retrieve additional content from parent or child items Mobile SDK method: AddScope(ScopeType),AddScope(IEnummerable<ScopeType>) ItemWeb API param: scope Optional: Yes Item Request Parameters - Scope 20 Database Language Version Payload Fields Scope Paging
- 21. Usage Get paginated data in case of large result sets Mobile SDK method: ItemsPerPage(int) PageNumber(int) ItemWeb API param: perPage page Optional: Yes Yes Item Request Parameters - Paging 21 Database Language Version Payload Fields Scope Paging
- 23. Executing the request 23 All requests are executed by the ISitecoreWebApiSession interface instance Three overloads for ReadItemAsync • IReadItemsByIdRequest • IReadItemsByPathRequest • IReadItemsByQueryRequest * If you cannot use the async keyword with your method, use theTask.WaitAll() method instead ScItemsResponse response = await session.ReadItemAsync(request);
- 24. Creating Items 24 Requires authenticated session! Must specify • Parent id or path • Item name • ItemTemplate var request = ItemWebApiRequestBuilder.CreateItemRequestWithParentParentPath("/path/to/parent") .ItemTemplatePath(“Sample/Sample Item”) .ItemName(“Name of new item”) .Build();
- 25. Updating Items 25 Requires authenticated session Must specify • Field name • Field value (raw value) • Optional: language var request = ItemWebApiRequestBuilder.UpdateItemRequestWithId(“{item-id-GUID}”) .Language("en") .AddFieldsRawValuesByNameToSet("Text", “Hello!”) .Build(); var request = ItemWebApiRequestBuilder.UpdateItemRequestWithId(“{item-id-GUID}”) .Language(“dk") .AddFieldsRawValuesByNameToSet("Text", “Hej!”) .Build();
- 26. Deleting Items 26 Requires authenticated session Must specify • Database • Optional: Scope (remove parent or children) No support for language versions! var request = ItemWebApiRequestBuilder.DeleteItemRequestWithPath(itemPath) .Database(“master”) .Build();
- 28. Retrieving media 28 By default the mobile SDK returns the media item path Use the ItemWebApiRequestBuilder to download the media content // constructing a request string mediaPath = "/Images/green_mineraly1"; var request = ItemWebApiRequestBuilder.DownloadResourceRequestWithMediaPath(mediaPath).Build(); // processing the request using ( Stream response = awaitthis.session.DownloadMediaResourceAsync(request) ) { // working with the media resource stream }
- 29. Uploading Media 29 Required parameters • Item name • File name • Resource data • Parent item path or parent GUID var request = ItemWebApiRequestBuilder.UploadResourceRequestWithParentId({GUID-ITEM-ID}) .ItemDataStream(stream) .ItemName("MyMediaItem") .FileName("myPhoto.jpg") .Build(); var response = await session.UploadMediaResourceAsync(request);
- 30. HTML rendering request 30 Gets the HTML output of a Sitecore rendering Required parameters: • Source ID (Item ID) • Rendering ID var request =ItemWebApiRequestBuilder.RenderingHtmlRequestWithSourceAndRenderingId(sourceGUID, renderingGUID). Build();
- 32. Sorry, the current SDK (1.0) does not support personalization
- 33. Vision on Mobile and the SDK 33 Become the Sitecore integration layer for mobile apps • Upgrade the SDK to leverage the newest Sitecore features • No custom Sitecore integration needed • Easy maintainability and lower costs
- 35. Use Mobile SDK to retrieve items Requires personalized data Do not modify Mobile SDK since this runs client side Modifications must be done server side Use plain Sitecore installation
- 36. Sitecore.Services.Client provides a service layer on both the server and the client side of Sitecore applications that you use to develop data-driven applications. 36
- 37. The idea 37 ServicesAPI Controller SC_ANALYTICS_GLOBAL_COOKIE “Register device” Store cookie on device ServicesAPI Controller xDB xDB Response data Request with included cookie Create request
- 38. Sitecore ServicesWebAPI 38 Why should you use Sitecore.Services? • Anonymous user filters • Security policies • Handles logging Exposes two services • Item Service • Entity Service
- 39. The first steps 39 • Create CustomWebClient • Add CookieContainer • Create SessionApi Controller • Register routes
- 40. Customize ItemWebAPI 40 Mobile SDK ItemWeb API
- 41. Challenges 41 Pass data within the Mobile SDK to the ItemWeb API Add personalization to the ItemWeb API
- 43. Sending custom data using the Mobile SDK 43 Abuse fields field in a read request Mobile SDK method: AddFieldsToRead(string) ItemWeb API param: fields
- 44. Receiving data in the ItemWeb API 44 Add custom processor in the itemWebApiGetField pipeline Add method to retrieve data
- 45. Do something with the results 45
- 48. 48 Questions? Do you have more questions ? Go to community.sitecore.net 1900+ professionals are there to help you