OMCMobileEndpoint Class Reference

Inherits from NSObject
Declared in OMCMobileEndpoint.h

Overview

Represents an endpoint in a custom code API

  apiName

The name of the custom code API.

@property (nonatomic, readonly) NSString *apiName

Declared In

OMCMobileEndpoint.h

  endpointPath

The endpoint in the API.

@property (nonatomic, readonly) NSString *endpointPath

Declared In

OMCMobileEndpoint.h

– createObject

Creates a new MobileObject. The object is not uploaded to the service until Save is invoked.

- (id)createObject

Return Value

The new OMCMobileObject object or, if a custom mobile object entity is specified, it will return custom mobile object.

Declared In

OMCMobileEndpoint.h

– createFile

Creates a new MobileFile. The file is not uploaded to the service until Save is invoked.

- (OMCMobileFile *)createFile

Return Value

The new MobileFile.

Declared In

OMCMobileEndpoint.h

– getSynchronization

  • Returns the synchronization object from which the current mobile endpoint was created
- (OMCSynchronization *)getSynchronization

Return Value

synchronization OMCSynchronization object

Declared In

OMCMobileEndpoint.h

– fetchObjectCollectionBuilder

Method to fetch a builder to fetch a collection of objects from the endpoint. If the collection exists in the cache, and the policy is set to get from cache, the cached copy is returned. Otherwise it is downloaded from the service.

- (OMCFetchObjectCollectionBuilder *)fetchObjectCollectionBuilder

Return Value

The object of OMCFetchObjectCollectionBuilder

Declared In

OMCMobileEndpoint.h

– fetchObjectBuilder

Method to fetch a builder to fetch a object from the endpoint. If the object exists in the cache, and and the policy is set to get from cache, the cached copy is returned. Otherwise it is downloaded from the service.

- (OMCFetchObjectBuilder *)fetchObjectBuilder

Return Value

The object of OMCFetchObjectBuilder

Declared In

OMCMobileEndpoint.h

– fetchFileBuilder

Method to fetch a builder to fetch a file from the endpoint. If the file exists in the cache, and the policy is set to get from cache, the cached copy is returned. Otherwise it is downloaded from the service.

- (OMCFetchFileBuilder *)fetchFileBuilder

Return Value

The object of OMCFetchFileBuilder

Declared In

OMCMobileEndpoint.h

– fetchObjectBuilder:

Method to fetch a builder to fetch an object from the endpoint. If the object exists in the cache, and the policy is set to get from cache, the cached copy is returned. Otherwise it is downloaded from the service.

- (OMCFetchObjectBuilder *)fetchObjectBuilder:(NSString *)objectId

Parameters

objectId

id to append to the endpoint path

Return Value

The object of OMCFetchObjectBuilder

Declared In

OMCMobileEndpoint.h

– fetchFileBuilder:

Method to fetch a builder to fetch a file from the endpoint. If the file exists in the cache, and the policy is set to get from cache, the cached copy is returned. Otherwise it is downloaded from the service.

- (OMCFetchFileBuilder *)fetchFileBuilder:(NSString *)fileId

Parameters

fileId

id to append to the endpoint path

Return Value

The object of OMCFetchFileBuilder

Declared In

OMCMobileEndpoint.h

– absoluteUrl

Returns absolute url for the current mobile endpoint

- (NSString *)absoluteUrl

Return Value

absolute url string

Declared In

OMCMobileEndpoint.h