OMCMobileComponent Class Reference

Inherits from NSObject
Declared in OMCMobileComponent.h

Overview

A mobile component holds the settings that allow a service proxy to communicate with a mobile suite server.

  manager

The mobile component’s manager.

@property (readonly) OMCMobileManager *manager

Declared In

OMCMobileComponent.h

  name

The mobile component’s name, as specified by the OMC property list file (OMC.plist). The default name is determined by the implementation class.

@property (readonly) NSString *name

Declared In

OMCMobileComponent.h

  properties

The mobile component’s properties, as specified by the OMC property list file (OMC.plist).

@property (readonly) NSDictionary<NSString*id> *properties

Declared In

OMCMobileComponent.h

  baseURL

The mobile component’s base URL, upon which requests such as HTTP URLs are built. Typically, this URL is set via the OMC property list file (OMC.plist) and is in the form http://<host>:<port>.

@property (readonly) NSURL *baseURL

Declared In

OMCMobileComponent.h

  path

The mobile component’s path, which is appended to the baseURL to form the url. The mobile component path is determined by the subclass.

@property (readonly) NSString *path

Declared In

OMCMobileComponent.h

  url

The mobile component’s URL, upon which requests such as HTTP URLs are built. This URL is built by appending the current path to the current baseURL.

@property (readonly) NSURL *url

Declared In

OMCMobileComponent.h

  oAuthScope

The mobile component’s OAuth scope.

@property (readonly) NSString *oAuthScope

Declared In

OMCMobileComponent.h

  oAuthTokenEndPointURL

The mobile component’s OAuth token end point URL, which is used to acquire OAuth tokens, if necessary.

@property (readonly, nullable) NSURL *oAuthTokenEndPointURL

Declared In

OMCMobileComponent.h

– serviceProxyForClass:

Returns the receiver’s instance of the specified service proxy, if present. If the specified service proxy is not present, creates it via reflection and returns the new instance.

- (nullable OMCServiceProxy *)serviceProxyForClass:(Class)serviceProxyClass

Parameters

serviceProxyClass

The type of service proxy.

Discussion

Warning: Raises an NSInvalidArgumentException if serviceProxyClass is nil.

Declared In

OMCMobileComponent.h

– removeServiceProxy:

Removes the specified service proxy from the receiver.

- (void)removeServiceProxy:(OMCServiceProxy *)serviceProxy

Parameters

serviceProxy

The service proxy.

Discussion

Does nothing if the receiver does not contain serviceProxy.

Warning: Raises an NSInvalidArgumentException if serviceProxy is nil.

Declared In

OMCMobileComponent.h

– removeServiceProxyForClass:

Removes the receiver’s instance of the specified service proxy.

- (void)removeServiceProxyForClass:(Class)serviceProxyClass

Parameters

serviceProxyClass

The type of service proxy.

Discussion

Does nothing if the receiver does not contain the specified service proxy.

Warning: Raises an NSInvalidArgumentException if serviceProxyClass is nil.

Declared In

OMCMobileComponent.h