ASObject Class Reference
| Inherits from | NSObject |
| Declared in | ASObject.h |
Overview
Base class all Audiosocket data models subclass. Since most models have both a ‘name’ and an ID attribute they are defined here.
This class interfaces with the underlying RestKit library which handles the object mapping and underlying transport. This class is the only class which exposes any RestKit classes. By doing so it more advanced scenarios can be implemented.
Tasks
Accessing ASObject data model Properties
-
IDPrimary ID of this ASObject instance.
property -
nameName of this ASObject instance, e.g. “Don’t Stop Believing”
property
Mapping response data to object proproperties
-
+ objectManagerReturn the RestKit object manager singleton.
-
+ initializeMappings:Initializes the RestKit mapping for this class. Defaults to calling only [ASObject addInstanceResponseDescriptor]. It is overridden by classes that contain associated entities.
-
+ addInstanceResponseDescriptorAdds an RKResponseDescriptor descriptor as an instance descriptor. You should not have to make changes to this class, but it is exposed should you decide to override. See (RestKit object mapping)[https://github.com/RestKit/RestKit/wiki/Object-mapping] for details should you need them.
-
+ collectionResponseDescriptorAdds an RKResponseDescriptor descriptor as an collection descriptor. You should not have to make changes to this class, but it is exposed should you decide to override. See (RestKit object mapping)[https://github.com/RestKit/RestKit/wiki/Object-mapping] for details should you need them.
-
+ instanceObjectMappingReturns an RKObjectMapping instance to map the properties of this object. Defaults to ID and name mapping. Override to map attributes.
Defining destination endpoints.
-
+ endpointRootFor and endpoint like “https://api.audiosocket.com/v5/moods/345” this method should return “moods”.
-
+ instanceGetEndpointReturn the endpoint path, not including the baseURL portion, used to fetch an instance of this class. It defaults ‘<endpoint-root>/:id’. When actually fetching instances ‘:id’ is replaced with the actual id of the object.
Creating a new instance
-
– initWithID:Initialize an instance of this class with the ID provided.
-
– loadWithSuccess:failure:Loads an instance from the server. If you only have an ID for a instance you can do something like the following:
-
– loadFromPath:parameters:success:failure:Loads an instance from the server using the endpoint supplied. This is useful for classes that don’t have an ID, e.g. ASContext
-
– resolve:Return ‘self’ if targetID is equal self.ID. Overriden in subclasses that contain children.
Class Methods
addInstanceResponseDescriptor
Adds an RKResponseDescriptor descriptor as an instance descriptor. You should not have to make changes to this class, but it is exposed should you decide to override. See (RestKit object mapping)[https://github.com/RestKit/RestKit/wiki/Object-mapping] for details should you need them.
+ (RKResponseDescriptor *)addInstanceResponseDescriptorDeclared In
ASObject.hcollectionResponseDescriptor
Adds an RKResponseDescriptor descriptor as an collection descriptor. You should not have to make changes to this class, but it is exposed should you decide to override. See (RestKit object mapping)[https://github.com/RestKit/RestKit/wiki/Object-mapping] for details should you need them.
+ (RKResponseDescriptor *)collectionResponseDescriptorDeclared In
ASObject.hendpointRoot
For and endpoint like “https://api.audiosocket.com/v5/moods/345” this method should return “moods”.
+ (NSString *)endpointRootDiscussion
Note: must be overridden by subclass.
Declared In
ASObject.hinitializeMappings:
Initializes the RestKit mapping for this class. Defaults to calling only [ASObject addInstanceResponseDescriptor]. It is overridden by classes that contain associated entities.
+ (void)initializeMappings:(RKObjectManager *)objectManagerParameters
- objectManager
RestKit RKObjectManager to add the mapping to.
Declared In
ASObject.hinstanceGetEndpoint
Return the endpoint path, not including the baseURL portion, used to fetch an instance of this class. It defaults ‘<endpoint-root>/:id’. When actually fetching instances ‘:id’ is replaced with the actual id of the object.
+ (NSString *)instanceGetEndpointDeclared In
ASObject.hInstance Methods
initWithID:
Initialize an instance of this class with the ID provided.
- (ASObject *)initWithID:(NSInteger)IDParameters
- ID
Primary ID of this instance.
Declared In
ASObject.hloadFromPath:parameters:success:failure:
Loads an instance from the server using the endpoint supplied. This is useful for classes that don’t have an ID, e.g. ASContext
- (void)loadFromPath:(NSString *)path parameters:(NSDictionary *)params success:(void ( ^ ) ( id ))success failure:(void ( ^ ) ( NSError *))failureParameters
- path
Path specifying endpoint that will an instance of this class. It does not include the baseURL portion of the path.
- params
Optional query parameters that added to the request path.
- success
Called when the request returns successfully. The retrieved instance is passed to this block.
- failure
If supplied called when an error occurs during the request.
Declared In
ASObject.hloadWithSuccess:failure:
Loads an instance from the server. If you only have an ID for a instance you can do something like the following:
- (void)loadWithSuccess:(void ( ^ ) ( id asObject ))success failure:(void ( ^ ) ( NSError *error ))failureParameters
- success
Invoked when the request has completed successfully. ‘self’ is
passed to the block.
- failure
Invoked, if supplied, when an error occurs during the request or
subsequent data mapping.
Discussion
ASTrack *track = [[ASTrack alloc] initWithID:20];
[track loadWithSuccess:^(ASTrack *loadTrack) {
// Do something with the newly loaded track...
}
failure:^(NSError *error) {
// Handle error condition...
}
];
Declared In
ASObject.h