Knowledgebase

OpenFeint API Organization


Resources and Services

OpenFeint’s APIs are organized by resource. A resource is a single object that is interesting to a user or developer. Examples of resources in the OpenFeint SDK are achievement, high score, leaderboard, and user.

Almost every resource has a corresponding service that allows you to create, read, and update that resource or a list of that resource.

Resource Naming Conventions

All Objective-C definitions related to a resource are named after it. You can use this simple pattern for finding header files and class names for a resource:

OFResourceName and OFResourceNameService

Simply Replace ResourceName with the name of the resource you’re looking for.

Resource Example: Achievement

Using the pattern described above, it’s easy to intuit the header files and interface names for the Achievement resource:
Resource interface name: OFAchievement
Resource interface header file: OFAchievement.h
Resource service interface name: OFAchievementService
Resource service interfface header file: OFAchievementService.h