OMCMobileManager Class Reference
Inherits from | NSObject |
---|---|
Declared in | OMCMobileManager.h |
Overview
The mobile manager is the entry point to the Oracle Mobile Cloud Service SDK. It is responsible for building and holding the mobile backend and analytics app.
+ sharedManager
Returns the singleton mobile manager.
+ (OMCMobileManager *)sharedManager
Declared In
OMCMobileManager.h
mobileBackend
The mobile manager’s mobile backend. This is the mobile backend
configured in the OMC property list file (OMC.plist
).
@property (readonly, nullable) OMCMobileBackend *mobileBackend
Declared In
OMCMobileManager.h
– setMobileBackendWithProperties:
Sets and returns the receiver’s mobile backend,
initializing it with the specified properties.
The properties must be in the same form as the backend
properties in the OMC property list file (OMC.plist
).
- (OMCMobileBackend *)setMobileBackendWithProperties:(nullable NSDictionary<NSString*,id> *)properties
Parameters
properties |
The new mobile backend’s initial properties. |
---|
Discussion
Clears the receiver’s mobile backend if the specified properties is nil
.
If the receiver already contains a mobile backend, replaces it with the newly created mobile backend.
Declared In
OMCMobileManager.h
– buildMobileBackendWithProperties:
Builds and returns a new mobile backend,
initializing it with the specified properties.
The properties must be in the same form as the backend
properties in the OMC property list file (OMC.plist
).
Returns nil
if the specified properties is nil
.
- (OMCMobileBackend *)buildMobileBackendWithProperties:(nullable NSDictionary<NSString*,id> *)properties
Parameters
properties |
The new mobile backend’s initial properties. |
---|
Discussion
NB: The new mobile backend does not replace the mobile manager’s mobile backend; it is simply returned.
Declared In
OMCMobileManager.h
oAuthTokenEndPointURL
The mobile manager’s OAuth token end point URL, which is used by the
mobileBackend
and analyticsApp
to acquire OAuth tokens, if necessary.
This URL is built by appending the pre-defined OAuth token path
to the Identity Service base URL.
@property (readonly, nullable) NSURL *oAuthTokenEndPointURL
Declared In
OMCMobileManager.h
identityServiceBaseURL
The mobile manager’s Identity Service base URL, which is used to build
the manager’s OAuth token end point URL.
Typically, this URL is set via the OMC property list file (OMC.plist
)
and is in the form https://<host>:<port>
.
@property (nullable) NSURL *identityServiceBaseURL
Declared In
OMCMobileManager.h
logLevel
The mobile manager’s log level. This log level controls the volume of log entries
produced by the Oracle Mobile Cloud Service SDK. The log level can be set to one of the following
levels: "none"
, "error"
, "warning"
, "info"
, "debug"
.
This log level can be either initialized
from the default property list file (OMC.plist
) or set directly at
runtime via this property. If it is not set explicitly, the log level is error
.
@property (nonatomic) NSString *logLevel
Declared In
OMCMobileManager.h
logHTTP
The mobile manager’s log HTTP flag. This flag controls whether,
when logging HTTP requests,
the Oracle Mobile Cloud Service SDK also logs the headers and bodies of the requests.
This flag can be either initialized
from the default property list file (OMC.plist
) or set directly at
runtime via this property. If it is not set explicitly, the flag is NO
.
@property BOOL logHTTP
Declared In
OMCMobileManager.h
logHTTPMaxHeaderSize
The mobile manager’s log HTTP max header size. This value determines the
maximum number of characters to be logged when logging an HTTP header value.
If an HTTP header value is longer than the specified maximum, a truncated version
of the value will be logged with a trailing ellipsis (...
).
This value can be either initialized
from the default property list file (OMC.plist
) or set directly at
runtime via this property. If it is not set explicitly, the value is 100
.
If this value is set to 0
, all HTTP header values will be printed in entirety.
@property NSUInteger logHTTPMaxHeaderSize
Declared In
OMCMobileManager.h
logHTTPMaxBodySize
The mobile manager’s log HTTP max body size. This value determines the
maximum number of bytes to be logged when logging an HTTP body.
If an HTTP body is longer than the specified maximum, a truncated version
of the value will be logged with a trailing ellipsis (...
).
This value can be either initialized
from the default property list file (OMC.plist
) or set directly at
runtime via this property. If it is not set explicitly, the value is 10000
.
If this value is set to 0
, all HTTP bodies will be printed in entirety.
@property NSUInteger logHTTPMaxBodySize
Declared In
OMCMobileManager.h
properties
The mobile manager’s properties, as specified by the OMC property list file
(OMC.plist
).
@property (readonly, nonatomic) NSDictionary<NSString*id> *properties
Declared In
OMCMobileManager.h