Skip to Content
Ektron Developer's Guide: Building an Ektron Powered Website
book

Ektron Developer's Guide: Building an Ektron Powered Website

by Bill Cava, Bill Rogers, Aniel Sud
February 2011
Beginner to intermediate
672 pages
17h 10m
English
Wrox
Content preview from Ektron Developer's Guide: Building an Ektron Powered Website

Appendix B. Framework API

The Framework API is the newest member of the API set that Ektron includes with CMS400 .NET. It was added to promote discoverability and consistency. Discoverability means that a developer should be able to guess the namespace, object name, and method to use without having to read through huge amounts of documentation. With a well designed API, users should be able to intuit their way through a situation using context clues delivered by the naming of objects and IntelliSense.

For consistency, the goal was to make the API work in similar ways for similar functions. Therefore, it should be easy to understand how to work with a given object because it works in the same way as other objects you have already used. The final goal was to make the API simple to use. It should make easy things easy to do, while steering developers down the path of having easily maintainable code that follows best practices, without needing to keep a large number of rules in mind.

This appendix discusses some of the overall themes of the Framework API, and then jumps into a few snippets demonstrating how to achieve some typical simple goals.

WORKING WITH THE FRAMEWORK API

There are two points to understand before you can effectively work with the Framework API. The first is how the API interacts with the underlying permission model, and the second is the overall construction of the API. For the Framework API, the permissions flag is set when the API objects are initially created, by ...

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Read now

Unlock full access

More than 5,000 organizations count on O’Reilly

AirBnbBlueOriginElectronic ArtsHomeDepotNasdaqRakutenTata Consultancy Services

QuotationMarkO’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.
Julian F.
Head of Cybersecurity
QuotationMarkI wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.
Addison B.
Field Engineer
QuotationMarkI’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.
Amir M.
Data Platform Tech Lead
QuotationMarkI'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
Mark W.
Embedded Software Engineer

You might also like

Designing Storage Area Networks: A Practical Reference for Implementing Fibre Channel and IP SANs, Second Edition

Designing Storage Area Networks: A Practical Reference for Implementing Fibre Channel and IP SANs, Second Edition

Tom Clark
What Successful Project Managers Do

What Successful Project Managers Do

W. Scott Cameron, Jeffrey S. Russell, Edward J. Hoffman, Alexander Laufer
The Human Factor in AI-Based Decision-Making

The Human Factor in AI-Based Decision-Making

Philip Meissner, Christoph Keding

Publisher Resources

ISBN: 9780470885697Purchase book