Developer

Application Development in SAP Mobile Platform

Application and Device Security Overview

Logging and Tracing Overview

REST API App Development

Client Hub

Prerequisites

Managing iOS Application Registration Using Client Hub

Getting Started with Client Hub Application Installation and Initialization

Configuring Business Application with Client Hub

Managing Android Application Registration Using Client Hub

Getting Started with Client Hub Application Installation and Initialization

Configuring Business Application with Client Hub

Native OData Application Development

Native OData App Development Using the OData API

Best Practices for Online OData App Development

SAP Annotations for OData Version 2.0

Offline OData Version Support

Setting Up the Native OData Development Environment

Android Environment Requirements

iOS Environment Requirements

Windows Development Requirements

Supported Environments and Application Types

iOS Applications

Creating a Project and Importing the OData Libraries and Bundles

Developing iOS Online OData Applications

Registering Devices and Connecting Users

Initializing an Online Store

Read Operations

Making HTTP Get Requests from Whitelisted Connections

Perform Create, Update, Delete Operations

Create Operations

Update Operations

Delete Operations

Miscellaneous Operations

Function Imports

Logging Operations

Developing iOS Offline OData Applications

Defining an Application Configuration File with Defining Requests

Defining Requests

Performance Improvement with Caching and Delta Tracking

Application Configuration File

Querying and Modifying Offline Data

Updating and Refreshing Offline Data

Offline OData Refreshes and Updates

Designing an Offline Application to Handle Conflicts and Errors

Offline OData Conflicts and Errors

Configuring an Offline Application to Access the ErrorArchive

Additional Offline OData Features

Sample Metadata for Offline OData

OData APIs for iOS

OData Online API for iOS

SAP Mobile Platform 3.0 OData SDK for iOS

SODataCertificateCredentials class

SODataConstants class

SODataConverter class

annotationsDictFromXSAnnotationMap: method

complexPropertiesDictFromXSComplexTypeMap: method

convertPropertiesOfSODataEntity:xsEntity:error: method

convertPropertiesOfXSEntity:toEntityProperties:error: method

convertXSPropertyDataValue:withPropertyInfo:error: method

dateComponentsFromXSGlobalDateTime: method

dateFromXSDateTime: method

entityFromString:entitySet:error: method

entityFromXSEntity:context:error: method

entitySetFromResourcePath:propertyInfo:functionImport:requestMethod:responseType: method

entitySetFromString:entitySet:error: method

entitySetFromXSEntityList:context:error: method

errorFromString:error: method

facetDictFromXSParam: method

facetDictFromXSPropertyInfo: method

initWithUrl:csdl: method

linkFromString:error: method

linksFromString:error: method

mapXSTypeToEDMType:typeName: method

navigationPropertiesDictFromXSNavigationPropertiesList: method

oDataEntitySetFromXSEntitySet: method

oDataMetaEntityContainerFromXSEntityContainer: method

propertiesDictFromXSPropInfoList: method

propertyFromString:entitySet:propertyInfo:error: method [deprecated]

rawValueFromString: method

relationIdentifierFromRel: method

serializedDataFromEntity:buildStyle:entitySet:error: method

serializedDataFromEntitySet:buildStyle:entitySet:error: method

serializedDataFromEntitySet:buildStyle:entitySet:error: method

serializedDataFromLink:buildStyle:error: method

serializedDataFromLink:buildStyle:error: method

soDataDurationFromXSDayTimeDuration: method

SODataMetadataFromXS_CsdlDocument:metadataXML:error: method

xSDayTimeDurationFromSODataDuration: method

xsEntityListFromEntitySet:entitySet:error: method

xsEntryFromEntity:entitySet:error: method

xSGlobalDateTimeFromDate: method

xSLocalDateTimeFromDate: method

SODataCredentials protocol

SODataOnlineStore class

allocateNavigationProperties:error: method

allocatePropertiesOfEntity:mode:error: method

asyncRequests method

dealloc method

determineEntitySetFromResourcePath:error: method

determineEntityTypeFromResourcePath:error: method

determineODataTypeFromResourcePath:mode:error: method

downloadMetaData method

executeCreateEntity:collectionPath:options:error: method

executeDeleteEntity:etag:options:error: method

executeDeleteEntity:options:error: method

executeFunction:options:error: method

executePatchEntity:options:error: method

executeReadEntity:options:error: method

executeReadEntitySet:options:error: method

executeReadEntityWithResourcePath:options:error: method

executeReadLink:options:error: method

executeReadLinkSet:options:error: method

executeReadPropertyComplex:options:error: method

executeReadPropertyPrimitive:options:error: method

executeReadPropertyRaw:options:error: method

executeRequest:error: method

executeUpdateEntity:options:error: method

initWithURL:httpConversationManager: method

initWithURL:httpConversationManager:options: method

openStoreWithError: method

openWithURL: method

requestExecutedWithId: method

requestExecutionFromBatchRequest:error:delegate: method

requestExecutionFromSingleRequest:error:delegate: method

responseSingleFromResponse:error: method

scheduleCreateEntity:collectionPath:delegate:options: method

scheduleDeleteEntity:delegate:options: method

scheduleDeleteEntity:etag:delegate:options: method

scheduleFunction:delegate:options: method

schedulePatchEntity:delegate:options: method

scheduleReadEntity:delegate:options: method

scheduleReadEntitySet:delegate:options: method

scheduleReadEntityWithResourcePath:delegate:options: method

scheduleReadLink:delegate:options: method

scheduleReadLinkSet:delegate:options: method

scheduleReadPropertyComplex:delegate:options: method

scheduleReadPropertyPrimitive:delegate:options: method

scheduleReadPropertyRaw:delegate:options: method

scheduleRequest:delegate: method

scheduleUpdateEntity:delegate:options: method

setDefaultValueForProperty:propertyInfo: method

syncOpenStoreWithError: method

validateStoreWithError: method

SODataOnlineStoreDelegate protocol

onlineStoreOpenFailed:error: method

onlineStoreOpenFinished: method

SODataOnlineStoreOptions class

SODataRequestCredentialsDelegate protocol

credentialsForRequest method

SODataRequestExecutedDelegate protocol

requestExecutedWithId: method

SODataRequestExecutionBatchDefault class

addRequestExecutionFromRequestParam:toRequestArray:batchRequests:error: method

buildURLString method

createResponseChangesetFromRequest:urlRequest:httpResponses:error: method

initWithRequest: method

requestWithURL: method

responseFromRequest:httpResponse:responseData:error: method

setupPostBodyWithError: method

setupRequestMethod method

setupRequestParamsForRequest:requestParam:error: method

SODataRequestExecutionDefault class

addLocationAndCodeToResponse:httpResponse: method

buildURLString method

cancelExecution method

checkODataError: method

fullResourcePathFromResourcePathWithContentID:usingRequestParams: method

generateUUID method

initWithRequest: method

payloadFromRequest:httpResponse:responseData:requestParam:resolvedResourcePath:error: method

processHttpResponse:responseData:error: method

requestWithURL: method

responseFromFailedRequest:requestParam:requestError:httpResponse:responseData:error: method

responseFromFailedRequestWithRequestParam:error: method

responseFromRequest:httpResponse:responseData:error: method

responseFromSyncRequest:httpResponse:responseData:error: method

runSyncRequest method

setBaseURL:csdl: method

setupPostBodyWithError: method

setupRequestHeaders method

setupRequestMethod method

setupRequestWithError: method

startAsyncNetworkRequest method

startAsyncRequest method

startSyncRequestWithError: method

waitForSyncFinish method

SODataRequestExecutionSingleDefault class

buildURLString method

cancelExecution method

dealloc method

requestWithURL: method

responseFromRequest:httpResponse:responseData:error: method

setupPostBodyWithError: method

setupRequestHeaders method

setupRequestMethod method

setupWithError: method

SODataUserCredentials class

SODataUtility class

addMissingRequestHeadersToDict: method

createErrorCode: method

error method

errorFromException: method

errorWithDomain:code:description:underlyingError: method

errorWithDomain:code:description:underlyingException: method

initialize method

isNetworkAvailable method

validateRequest:withError: method

XS_DataContextDefault class

DC1::: method

forATOM:: method

forJSON:: method

format method

getComplexType: method

getDeferred::: method

getDocument:: method

getEntitySet: method

getEntityType: method

init method

new method

setCsdl: method

setFormat: method

XS_DeferredValueDefault class

newDeferredValueWithType:entitySet:location: method

resolve method

Deprecated API List

OData Offline API for iOS

SODataOfflineStore class

closeStoreWithError: method

GlobalFini method

GlobalInit method

LibraryVersion method

openStoreWithOptions:error: method

RemoveStoreWithOptions:error: method

scheduleFlushQueuedRequestsWithDelegate: method

scheduleRefreshWithDelegate: method

scheduleRefreshWithRefreshSubset:delegate: method

offlineStoreDelegate property

open property

requestErrorDelegate property

SODataOfflineStoreDelegate protocol

offlineStoreNotification:notification: method

offlineStoreOpenFailed:error: method

offlineStoreOpenFinished: method

offlineStoreStateChanged:state: method

SODataOfflineStoreFlushDelegate protocol

offlineStoreFlushFailed:error: method

offlineStoreFlushFinished: method

offlineStoreFlushStarted: method

offlineStoreFlushSucceeded: method

SODataOfflineStoreOptions class

conversationManager property

customCookies property

customHeaders property

definingRequests property

enableHttps property

enableRepeatableRequests property

extraStreamParms property

host property

port property

serviceRoot property

storeEncryptionKey property

storeName property

urlSuffix property

SODataOfflineStoreRefreshDelegate protocol

offlineStoreRefreshFailed:error: method

offlineStoreRefreshFinished: method

offlineStoreRefreshStarted: method

offlineStoreRefreshSucceeded: method

SODataOfflineStoreRequestErrorDelegate protocol

offlineStoreRequestFailed:request:error: method

OData API for iOS

SAP Mobile Platform 3.0 OData SDK for iOS

SODataAnnotationName protocol

SODataAnnotationNameDefault class

copyWithZone: method

initWithName:namespace: method

isEqual: method

SODataDuration class

reset method

SODataEntity protocol

navigationPropertyForRelationIdentifier: method

setMediaLink:editMediaLink:mediaContentType: method

setNavigationProperty:forRelationIdentifier: method

setResourcePath:editResourcePath: method

SODataEntityDefault class

initWithType: method

navigationLinkDict method

navigationPropertyForRelationIdentifier: method

navigationPropertyNames method

setMediaLink:editMediaLink:mediaContentType: method

setNavigationProperty:forRelationIdentifier: method

setResourcePath:editResourcePath: method

SODataEntitySet protocol

SODataEntitySetDefault class

init method

initWithCount: method

SODataError protocol

SODataErrorDefault class

initWithCode:message: method

SODataGuid class

convertBinaryToString32: method

convertString32ToBinary: method

convertToString32: method

convertToString36: method

guidAsBinary method

guidAsString32 method

guidAsString36 method

initWithBinary: method

initWithString32: method

initWithString36: method

SODataLink protocol

SODataLinkDefault class

initWithResourcePath: method

SODataLinkList protocol

SODataLinkListDefault class

init method

SODataMetaComplexType protocol

propertyForName: method

SODataMetaComplexTypeDefault class

initWithProperties: method

propertyForName: method

propertyNames method

SODataMetadata protocol

metaComplexForName: method

metaEntityContainerForName: method

metaEntityForName: method

SODataMetadataDefault class

initWithMetadataXML:namespaces:resourcePath:latestResourcePath:metaEntities:metaComplexTypes:metaEntityContainers: method

metaComplexForName: method

metaComplexNames method

metaEntityContainerForName: method

metaEntityContainerNames method

metaEntityForName: method

metaEntityNames method

SODataMetaEntityContainer protocol

annotation: method

annotationForName:namespace: method

functionImportForName: method

metaEntitySetForName: method

SODataMetaEntityContainerDefault class

annotationForAnnotationName: method

annotationForName:namespace: method

annotationNames method

entitySetNames method

functionImportForName: method

functionImportNames method

initWithFunctionImports:entitySets:annotations: method

metaEntitySetForName: method

SODataMetaEntitySet protocol

annotationForAnnotationName: method

annotationForName:namespace: method

SODataMetaEntitySetDefault class

annotationForAnnotationName: method

annotationForName:namespace: method

annotationNames method

initWithName:entityType:annotations: method

SODataMetaEntityType protocol

annotationForAnnotationName: method

annotationForName:namespace: method

navigationPropertyForName: method

propertyForName: method

SODataMetaEntityTypeDefault class

annotationForAnnotationName: method

annotationForName:namespace: method

annotationNames method

initWithName:isMediaEntity:properties:keyPropertyNames:navigationProperties:annotations: method

navigationPropertyForName: method

navigationPropertyNames method

propertyForName: method

propertyNames method

SODataMetaFunctionImport protocol

annotationForAnnotationName: method

annotationForName:namespace: method

parameterForName: method

SODataMetaFunctionImportDefault class

annotationForAnnotationName: method

annotationForName:namespace: method

annotationNames method

initWithName:returnTypeName:isReturnCollection:returnEntitySetName:callMethod:parameters:annotations: method

parameterForName: method

parameterNames method

SODataMetaFunctionParameter protocol

annotationForAnnotationName: method

annotationForName:namespace: method

facetForName: method

SODataMetaFunctionParameterDefault class

annotationForAnnotationName: method

annotationForName:namespace: method

annotationNames method

facetForName: method

facetNames method

initWithName:typeName:isCollection:facets:annotations:mode: method

SODataMetaNavigationProperty protocol

SODataMetaNavigationPropertyDefault class

initWithName:targetEntityType:isEntitySet: method

SODataMetaProperty protocol

annotationForAnnotationName: method

annotationForName:namespace: method

facetForName: method

SODataMetaPropertyDefault class

annotationForAnnotationName: method

annotationForName:namespace: method

annotationNames method

facetForName: method

facetNames method

initWithName:type:typeName:facets:annotations:isKey: method

SODataNavigationProperty protocol

SODataNavigationPropertyDefault class

hasNavigationInline method

navigationType method

SODataPayload protocol

SODataPayloadDefault class

SODataProperty protocol

SODataPropertyDefault class

initWithName: method

isComplex method

SODataRawValue protocol

SODataRawValueDefault class

initWithValue: method

SODataRequestBatchItem protocol

SODataRequestChangeset protocol

SODataRequestChangesetDefault class

add: method

get: method

init method

size method

SODataRequestDelegate protocol

requestCacheResponse: method

requestFailed:error: method

requestFinished: method

requestServerResponse: method

requestStarted: method

SODataRequestExecution protocol

cancelExecution method

initWithRequest: method

SODataRequestParam protocol

SODataRequestParamBatch protocol

SODataRequestParamBatchDefault class

add: method

get: method

init method

size method

SODataRequestParamSingle protocol

initWithMode:resourcePath: method

setResponseType: method [deprecated]

setResponseType:name: method [deprecated]

SODataRequestParamSingleDefault class

initWithMode:resourcePath: method

setResponseType: method

setResponseType:name: method

SODataResponse protocol

SODataResponseBatch protocol

SODataResponseBatchDefault class

initWithCustomTag:responses: method

isBatch method

SODataResponseBatchItem protocol

SODataResponseChangeset protocol

SODataResponseChangesetDefault class

initWithResponses: method

SODataResponseSingle protocol

SODataResponseSingleDefault class

initWithCustomTag:payload: method

isBatch method

payloadType method

SODataStore protocol

allocateNavigationProperties:error: method

allocatePropertiesOfEntity:mode:error: method

determineEntitySetFromResourcePath:error: method

determineEntityTypeFromResourcePath:error: method

determineODataTypeFromResourcePath:mode:error: method

SODataStoreAsync protocol

scheduleCreateEntity:collectionPath:delegate:options: method

scheduleDeleteEntity:delegate:options: method

scheduleDeleteEntity:etag:delegate:options: method

scheduleFunction:delegate:options: method

schedulePatchEntity:delegate:options: method

scheduleReadEntity:delegate:options: method

scheduleReadEntitySet:delegate:options: method

scheduleReadEntityWithResourcePath:delegate:options: method

scheduleReadLink:delegate:options: method

scheduleReadLinkSet:delegate:options: method

scheduleReadPropertyComplex:delegate:options: method

scheduleReadPropertyPrimitive:delegate:options: method

scheduleReadPropertyRaw:delegate:options: method

scheduleRequest:delegate: method

scheduleUpdateEntity:delegate:options: method

SODataStoreSync protocol

executeCreateEntity:collectionPath:options:error: method

executeDeleteEntity:etag:options:error: method

executeDeleteEntity:options:error: method

executeFunction:options:error: method

executePatchEntity:options:error: method

executeReadEntity:options:error: method

executeReadEntitySet:options:error: method

executeReadEntityWithResourcePath:options:error: method

executeReadLink:options:error: method

executeReadLinkSet:options:error: method

executeReadPropertyComplex:options:error: method

executeReadPropertyPrimitive:options:error: method

executeReadPropertyRaw:options:error: method

executeRequest:error: method

executeUpdateEntity:options:error: method

Deprecated API List

Usage Collection

Automatically Reported Data

Timer

Usage Collection API

SAP Mobile Platform 3.0 OData SDK for iOS

Usage class

initUsageWithURL:httpConversationManager: method

initUsageWithURL:httpConversationManager:dataEncryptionKey: method

log: method

log:info: method

log:info:type: method

makeTimer: method

stopTimer: method

timeEnd: method

timeStart: method

Developing with MAF Logon for iOS

Architectural Overview

MAF Logon Task Flow

Create Your Logon Handler

Integrate Logon Handler in Your App

Present the Logon Screen

Adding SAP Discovery Service

Executing Logon Operations

Data Requests

Handling Delegate Calls

Error Handling

Onboarding with SAP Mobile Place

SAP Mobile Place Workflow

HttpConversation Workflow

Developing Logon with Certificate Authentication

Developing Logon with Afaria

Developing Logon with Third-Party Certificate Provider

Mutual Certificate Handling

API Reference

CertificateProvider protocol

getCertificate:delegate method

getStoredCertificate:error method

deleteStoredCertificateWithError:error method

CertificateProviderDelegate protocol

currentViewController method

onGetCertificateSuccess method

onGetCertificateFailure:error method

SAML Authentication

Customizing the Logon UI

Logon Screen Configuration Options

Data Vault Life Cycle

MAF Onboarding Scenarios

MAF Configuration Provisioning

Logon APIs for iOS

HttpConversation API

SAP Mobile Platform 3.0 OData SDK for iOS

ChallengeFilterProtocol protocol

handleChallenge:conversationManager:completionBlock: method

ChallengeHandler class

URLSession:task:didReceiveChallenge:completionHandler: method

ChangeSet class

ClientCertObserverProtocol protocol

observeClientCertificate: method

HttpConversationManager class

addChallengeFilter: method

addObserver: method

addRequestFilter: method

addResponseFilter: method

allChallengeFilters method

allObservers method

allRequestFilters method

allResponseFilters method

copy method

currentTimeInMilis method

executeRequest:completionHandler: method

executeRequest_Private:completionHandler: method

generateTraceEntriesFromRequest: method

generateTraceEntriesFromResponse:receivedData:method: method

init method

setResponseData:intoResponse:error: method

URLSession:task:didReceiveChallenge:completionHandler: method

HttpConversationObserverProtocol protocol

ManagerConfiguratorProtocol protocol

configureManager: method

PluginProviderProtocol protocol

RequestFilterProtocol protocol

prepareRequest:conversationManager:completionBlock: method

ResponseFilterProtocol protocol

processResponse:responseData:conversationManager:completionBlock: method

SAPProvider class

SupportabilityUploader class

initWithHttpConversationManager:urlRequest: method

sendWithContentType:headers:payloadType:payload:completion: method

statusCodeToErrorMessage: method

batchElements_C method

dataTaskWithMutableRequest_Block method

sessionConfiguration_C method

setBatchElements_C method

setSessionConfiguration_C method

setupRequestWithXCSRFToken method

setXCSRFToken_Private method

start_C method

XCSRFToken_Private method

XCSRFTokenFromResponse method

Deprecated API List

HttpConvAuthFlows API

SAP Mobile Platform 3.0 OData SDK for iOS

AuthenticationUIViewController class

addContentViews method

authenticationCanceled method

closeActivityIndicator method

initWithParentViewController: method

privateCloseActivityIndicator method

privateShowActivityIndicatorWithText: method

showActivityIndicatorWithText: method

viewDidLoad method

webView:shouldStartLoadWithRequest:navigationType: method

webViewDidFinishLoad: method

AuthenticationUIViewControllerDelegate protocol

authenticationCanceled method

BaseChallengeFilter class

BaseRequestFilter class

BaseResponseFilter class

ClientCertChallengeFilter class

callNextProviderOfEnumerator:completionBlock: method

handleChallenge:conversationManager:completionBlock: method

ClientCertProviderProtocol protocol

provideClientCertForAuthChallenge:completionBlock: method

CommonAuthenticationConfigurator class

addClientCertProvider: method

addOAuth2ConfigProvider: method

addSAML2ConfigProvider: method

addUsernamePasswordProvider: method

allClientCertProvider method

allOAuth2ConfigProvider method

allSAML2ConfigProvider method

allUsernamePasswordProvider method

configureManager: method

HttpConvAuthFlowsLocalizationManager class

localizationBundle method

localizedStringForKey: method

OAuth2ConfigProviderProtocol protocol

isAcceptedResponse:forProvidedToken:completionBlock: method

provideOAuth2ConfigurationForURL:completionBlock: method

provideOAuth2TokenForURL:completionBlock: method

OAuth2RequestFilter class

addTokenToAuthorizationHeader method

authenticationCanceled method

callCompletionHandler method

callNextConfigProviderOfEnumerator:completionBlock: method

callNextTokenProviderOfEnumerator:completionBlock: method

closeWebView method

displayLoginWebView: method

prepareRequest:conversationManager:completionBlock: method

retrieveTokenForAuthorizationCode method

retrieveTokenFromResponseData: method

startOAuthFlow method

webView:shouldStartLoadWithRequest:navigationType: method

webViewDidFinishLoad: method

OAuth2TokenObserverProtocol protocol

observeOAuth2Token: method

SAML2ConfigProviderProtocol protocol

provideSAML2ConfigurationForURL:completionBlock: method

SAML2ResponseFilter class

authenticationCanceled method

callNextConfigProviderOfEnumerator:completionBlock: method

checkIfSAMLNeeded method

closeWebView method

displayLoginWebView method

processResponse:responseData:conversationManager:completionBlock: method

startSAMLAuth method

webView:shouldStartLoadWithRequest:navigationType: method

webViewDidFinishLoad: method

UsernamePasswordChallengeFilter class

callNextProviderOfEnumerator:completionBlock: method

handleChallenge:conversationManager:completionBlock: method

UsernamePasswordProvider class

alertView:clickedButtonAtIndex: method

provideUsernamePasswordForAuthChallenge:completionBlock: method

UsernamePasswordProviderProtocol protocol

provideUsernamePasswordForAuthChallenge:completionBlock: method

Deprecated API List

Mobile Place API

SAP Mobile Platform 3.0 OData SDK for iOS

MobilePlaceController class

configurationParametersWithAppID:versionNumber:parentVC:completionBlock: method

configurationParametersWithEmail:appID:versionNumber:parentVC:completionBlock: method

presentMobilePlaceViewControllerWithMobilePlaceUtil: method

MobilePlaceLocalizationManager class

localizationBundle method

localizedStringForKey: method

MobilePlaceUtil class

createErrorWithErrorCode:localizationKey: method

createMobilePlaceParametersDictionaryFromConfigParameters: method

dismissMobilePlaceViewController method

downloadJsonWithCompletionBlock: method

fetchConfigurationWithCompletionBlock: method

parseJson:withError: method

parseProtocolParam: method

resolveMobilePlaceServer method

validEmailAddress method

MobilePlaceViewController class

cancelBtnPressed: method

displayError: method

doneBtnPressed: method

viewWillAppear: method

Deprecated API List

Supportability for iOS

Logging and Tracing Overview

Implement Logging and Tracing in iOS Native Application

Supportability API for iOS

SAP Mobile Platform 3.0 OData SDK for iOS

SAPClientLogger protocol

getLogLevel method

initWithDb:andWithLock: method

isDestinationSet: method

log:withMessage: method

log:withMessage:withTransactionId:withCorrelationId: method

logDebug: method

logDebug:withTransactionId:withCorrelationId: method

logError: method

logError:withTransactionId:withCorrelationId: method

logFatal: method

logFatal:withTransactionId:withCorrelationId: method

logInfo: method

logInfo:withTransactionId:withCorrelationId: method

logWarning: method

logWarning:withTransactionId:withCorrelationId: method

SAPClientLogManager protocol

getLogEntries: method

getLogEntriesForLogger:withLevel: method

getLogger: method

getRawLogData method

setLogDestination: method

setLogDestination:forIdentifier: method

setLogLevel: method

setLogLevel:forIdentifier: method

setRootContextId: method

sharedManager method

uploadClientLogs:completion: method

SAPE2ETrace protocol

createTraceRequest: method

endTraceRequest:error: method

getE2ETraceLevel method

sharedInstance method

SAPE2ETraceManager protocol

endTransaction:error: method

getActiveStep method

getActiveTrace method

getActiveTransaction method

getBTX: method

sharedInstance method

startTransaction:error: method

uploadBTX:completion: method

SAPE2ETraceRequest protocol

endRequest: method

getCorrelationIdHTTPHeader method

getPassportHTTPHeader method

getTransactionID method

getXML method

init method

markReceived: method

markReceiving: method

markSending: method

markSent: method

setByteCountReceived: method

setByteCountSent: method

setDuration: method

setRequestHeaders: method

setRequestHeadersDictionary: method

setRequestLine: method

setResponseHeaders: method

setResponseHeadersDictionary: method

setReturnCode: method

SAPE2ETraceStep protocol

endRequest:error: method

endStep: method

getRequests method

getXML: method

init method

startRequest: method

SAPE2ETraceTransaction protocol

endStep: method

endTransaction: method

getActiveStep method

getBTX: method

initWithName: method

startStep: method

SAPSupportabilityFacade class

getClientLogger: method

getClientLogManager method

getE2ETrace method

getE2ETraceManager method

init method

sharedManager method

SAPSupportabilityFacade protocol

getClientLogger: method

getClientLogManager method

getE2ETrace method

getE2ETraceManager method

sharedManager method

NS_ENUM method

NS_ENUM method

NS_ENUM method

NS_OPTIONS method

Deprecated API List

ClientLog API for iOS

SAP Mobile Platform 3.0 OData SDK for iOS

SAPClientLogEntry class

init method

initWithMessage:andLevel:andTimestamp: method

setDefaultValues method

SAPClientLogger class

debugDescription method

description method

formatLogEntryForConsole: method

generateGuid method

init method

initWithDb:andWithLock: method

isDestinationSet: method

log:withMessage: method

log:withMessage:withTransactionId:withCorrelationId: method

logDebug: method

logDebug:withTransactionId:withCorrelationId: method

logError: method

logError:withTransactionId:withCorrelationId: method

logFatal: method

logFatal:withTransactionId:withCorrelationId: method

logInfo: method

logInfo:withTransactionId:withCorrelationId: method

logToFileSystem: method

logWarning: method

logWarning:withTransactionId:withCorrelationId: method

sanitizeString: method

SAPClientLogManager class

createTableIfNotExists: method

databasePath method

dealloc method

extractField:fieldIndex: method

formatLogEntryForUpload: method

getLogDataFormatted: method

getLogEntries: method

getLogEntriesForLogger:withLevel: method

getLogEntriesWithQuery: method

getLogger: method

getRawLogData method

init method

removeDatabaseAtPath: method

setLogDestination: method

setLogDestination:forIdentifier: method

setLogLevel: method

setLogLevel:forIdentifier: method

setRootContextId: method

sharedManager method

uploadClientLogs:completion: method

SAPClientLogUtils class

logLevelLiteral: method

timeZoneStringFrom: method

Deprecated API List

E2ETrace API for iOS

SAP Mobile Platform 3.0 OData SDK for iOS

SAPE2EDateFormatter class

dateFormatter method

SAPE2EExtendedPassport class

initWithRootId:andTraceLevel: method

initWithRootId:andTraceLevel:andTransportId:andTerminalId: method

setupNetDataForLevel:transportId: method

stripInvalidCharactersFromString: method

SAPE2ETrace class

createTraceRequest: method

endTraceRequest:error: method

getE2ETraceLevel method

init method

sharedInstance method

SAPE2ETraceManager class

endTransaction:error: method

getActiveStep method

getActiveTrace method

getActiveTransaction method

getBTX: method

incrementRequest method

incrementStep method

init method

sharedInstance method

startTransaction:error: method

stringifyData: method

traceFlags method

traceFlagsAsString method

uploadBTX:completion: method

SAPE2ETraceRequest class

datefromString: method

endRequest: method

getCorrelationIdHTTPHeader method

getPassportHTTPHeader method

getTransactionID method

getXML method

init method

initRequest: method

markReceived: method

markReceiving: method

markSending: method

markSent: method

setByteCountReceived: method

setByteCountSent: method

setDuration: method

setRequestHeaders: method

setRequestHeadersDictionary: method

setRequestLine: method

setResponseHeaders: method

setResponseHeadersDictionary: method

setReturnCode: method

stringFromNil: method

stringTimestamp method

stringTimestampFromDate: method

updateRequestWithValue:forKey: method

SAPE2ETraceStep class

endRequest:error: method

endStep: method

getRequests method

getXML: method

init method

startRequest: method

SAPE2ETraceTransaction class

endStep: method

endTransaction: method

getActiveStep method

getBTX: method

initWithName: method

startStep: method

SAPE2EUIDCreator class

createUUID method

createUUIDAsString method

NS_ENUM method

Deprecated API List

Developing with iOS Reusable UI Components

Getting Started

MAF Template Project

MAF Skinning

The MAF Skinning Mechanism

Skinning Custom Controls

Using Storyboard or Interface Builder

MAF Simple Controls

Project Setup

Creating iOS Starter Application

Prepare the Project Structure and Copy Dependencies to Your Project

Configure Your Xcode Project

Build Configuration

MAFUIView

MAFUIButton

MAFUILabel

MAFUITextField

MAFUISlider

MAFUIProgressView

MAFUIStepper

MAFUITabBar

MAFUISearchBar

Bars and Items

MAFUISwitch

MAFUITextView

MAFUIImageView

MAFUITableView and MAFUITableViewCell

MAFUIActivityIndicator

MAFUISegmentedControl

MAF Calendar

Project Setup

Creating iOS Starter Application

Prepare the Project Structure and Copy Dependencies to Your Project

Configure Your Xcode Project

Build Configuration

MAF Calendar Overview

Presenting Calendar Views

List View

Month View

Month Combo View

Day Detail View

Week View - Landscape View

Skinning Calendar Views

Styling the List View

Styling the Month Combo View

Styling the iPhone Month View

Styling the iPad Month View

Stlying the Day Detail View

Styling the Week View

MAF Formatters

Dependencies and Project Setup

MAF Formatter Types

MAFDateTimeFormatter

MAFCurrencyFormatter

Phone Number Formatter

MAFAddressFormatter

MAF Locale-Aware Controls

The Controls

Currency Control

Currency Value with Selector Control

Phone Number Control

Address Control

Dependencies and Project Setup

Setting Up a Frame for a Sample Application

Creating the Controls - the Base Classes

Skinning the Controls

Setting Value Help Options

MAF Tree View

Dependencies and Project Setup

Preparing Data and Content for the MAF Tree View

Creating the MAF Tree View Controls

Browsing Mode

Editing Mode

Rebranding the Tree View Component

MAF Utility Components

Developing with the Extensibility Framework

Architectural Overview

Prerequisites

Implementing an Extensible Application

Environment Prerequisites

Sample Applications

Creating a New Project

Adding the Required Dependencies

MAF Libraries

Configuring Build Settings

Default Layout and Style Configurations

Implement an Extensible Application

Setting Up a New Project

Adding the Required MAF Dependencies

Adding Resources

Adding Binary Dependencies

Defining the Extensibility Metadata XML

Your First Extensible App

Displaying Text

Adding Custom Code

Adding Custom Styling

Working with Data

Using Expressions

Adding Built-in Style and Layout Configuration Files

Adding and Accessing Localized Texts

Using Localization Key in Configuration

Localized Offline Demo Data Management

Creating Offline Demo Data

Demo Data Bundled with the App

Demo Data Provisioned via ACP

Adding and Accessing Default Images

Specifying Default Images

Implementation and Coding

Loading the Library

Initialization Status

Framework Busy States

Fully Metadata-Driven Apps

Mixing Coded and Metadata-Driven Tiles

Intercepting Tile Creation Events

Adding Extensible UIs to an Existing App

Coded Subviews Embedded in Metadata-Driven Tiles

Adding Configuration-Based Tiles to Programmed View Controllers

Provisioning Configuration-Based Tiles with Custom Data

Embedding a Custom Control in a Metadata-Driven Tile

Listening for Configuration-Based Control Events

Feeding the Tile with Custom Data

Creating Custom UI Elements

Fixing Data Validation Issues

Handling Provisioning Updates

Mobile Application Workbench

Logging and Tracing

Features Not Supported

Technical Details

Generic Business Object

Extensibility Layout XML

Extensibility Configuration XSD

Tile Bindings

Tile Containers

Tile Definitions

Tile Layouts

List Management

Context Management

Automatic and Explicit Context Updates

Responses to Context Update Events

Global Context Management

Definitions of Events and Actions

Formatters

Amounts with Currency

Date and Time

Phone Number

Address

Functions

Use of Functions in Configuration

Data Source Adaptor

Extensibility Configuration Management

Application Configuration Profile Directory and Contents

Uploading Configuration Profiles

Enabling Apple Push Notifications (APNS)

Running and Testing iOS Applications

Deploying iOS Applications

Generating a Certificate Request File

Creating an App ID

Configuring the App ID for Push Notifications

Creating the Provisioning File

Analyzing Logs and Debugging Errors in iOS Devices

Android Applications

Creating a Project and Importing the OData Libraries

Developing Android Online OData Applications

Registering Devices and Connecting Users

Initializing an Online Store

Read Operations

Making HTTP Get Requests from Whitelisted Connections

Create, Update, Delete Operations

Create Operations

Update Operations

Delete Operations

Miscellaneous Operations

Function Imports

Logging Operations

Developing Android Offline OData Applications

Defining an Application Configuration File with Defining Requests

Defining Requests

Performance Improvement with Caching and Delta Tracking

Application Configuration File

Querying and Modifying Offline Data

Updating and Refreshing Offline Data

Offline OData Refreshes and Updates

Designing an Offline Application to Handle Conflicts and Errors

Offline OData Conflicts and Errors

Configuring an Offline Application to Access the ErrorArchive

Additional Offline OData Features

Sample Metadata for Offline OData

OData APIs for Android

OData Online Store API for Android

com.sap.smp.client package

odata package

online package

ODataContext class

ODataContext() constructor

forATOM(CsdlDocument, EntitySet) method

forJSON(CsdlDocument, EntitySet) method

getComplexType(java.lang.String) method

getCsdl() method

getDeferred(DataType, EntitySet, String) method

getDocument(DataType, String) method

getEntitySet(String) method

getEntityType(java.lang.String) method

getFormat() method

setCsdl(com.sap.xscript.csdl.CsdlDocument) method

setFormat(int) method

ODataDeferredValue class

ODataDeferredValue(DataType, EntitySet, String) constructor

getDataType() method

getEntitySet() method

resolve() method

OnlineODataStore class

OnlineODataStore.OnlineStoreOptions class

OnlineStoreOptions() constructor

OnlineStoreOptions(PayloadFormatEnum) constructor

format variable

OnlineODataStore.PayloadFormatEnum enum

Default variable

JSON variable

XML variable

OnlineODataStore.ODataStoreOpenExecution interface

cancel() method

OnlineODataStore.OpenListener interface

storeOpened(OnlineODataStore) method

storeOpenError(ODataException) method

allocateNavigationProperties(ODataEntity) method

allocateProperties(ODataEntity, PropMode) method

determineEntitySet(String) method

determineEntityType(String) method

determineODataType(String, ODataRequestParamSingle.Mode) method

executeCreateEntity(ODataEntity, String, Map< String, String >) method

executeDeleteEntity(ODataEntity, Map< String, String >) method

executeDeleteEntity(String, String, Map< String, String >) method

executeFunction(String, Map< String, String >) method

executePatchEntity(ODataEntity, Map< String, String >) method

executeReadEntity(String, Map< String, String >) method

executeReadEntity(ODataEntity, Map< String, String >) method

executeReadEntitySet(String, Map< String, String >) method

executeReadLink(String, Map< String, String >) method

executeReadLinkSet(String, Map< String, String >) method

executeReadPropertyComplex(String, Map< String, String >) method

executeReadPropertyPrimitive(String, Map< String, String >) method

executeReadPropertyRaw(String, Map< String, String >) method

executeRequest(ODataRequestParam) method

executeUpdateEntity(ODataEntity, Map< String, String >) method

getBaseUrl() method

getLogger() method

getMetadata() method

open(Context, URL, HttpConversationManager, OpenListener, OnlineStoreOptions) method

open(Context, URL, HttpConversationManager, OnlineStoreOptions) method

scheduleCreateEntity(ODataEntity, String, ODataRequestListener, Map< String, String >) method

scheduleDeleteEntity(ODataEntity, ODataRequestListener, Map< String, String >) method

scheduleDeleteEntity(String, String, ODataRequestListener, Map< String, String >) method

scheduleFunction(String, ODataRequestListener, Map< String, String >) method

schedulePatchEntity(ODataEntity, ODataRequestListener, Map< String, String >) method

scheduleReadEntity(String, ODataRequestListener, Map< String, String >) method

scheduleReadEntity(ODataEntity, ODataRequestListener, Map< String, String >) method

scheduleReadEntitySet(String, ODataRequestListener, Map< String, String >) method

scheduleReadLink(String, ODataRequestListener, Map< String, String >) method

scheduleReadLinkSet(String, ODataRequestListener, Map< String, String >) method

scheduleReadPropertyComplex(String, ODataRequestListener, Map< String, String >) method

scheduleReadPropertyPrimitive(String, ODataRequestListener, Map< String, String >) method

scheduleReadPropertyRaw(String, ODataRequestListener, Map< String, String >) method

scheduleRequest(ODataRequestParam, ODataRequestListener) method

scheduleUpdateEntity(ODataEntity, ODataRequestListener, Map< String, String >) method

URLParser class

URLParser.URLParserResult class

URLParserResult(String, String, Type, String, String) constructor

getEntitySetName() method

getEntityTypeName() method

getFunctionImportName() method

getPropertyName() method

getType() method

parseURL(CsdlDocument, String, ODataRequestParamSingle.Mode) method

ODataAPIBridge enum

convertDataFromXScript(DataValue) method

convertDataToXScript(Object, int) method

convertTypeFromXScript(DataType) method

createEntity(EntityValue, CsdlDocument, DataContext, URL, boolean) method

createEntitySet(EntityValueList, CsdlDocument, URL, boolean) method

createFeed(ODataEntitySet, CsdlDocument, DataContext) method

createLink(DeferredValue) method

createLinkList(ObjectList) method

createMetadata(CsdlDocument, String) method

createODataError(ErrorResponse) method

createProperty(String, DataValue) method

createXScriptEntity(ODataEntity, CsdlDocument, DataContext) method

isXScriptException(RuntimeException) method

OData Offline Store API for Android

com.sap.smp.client package

odata package

offline package

ODataOfflineException class

getCode() method

getMessage() method

ODataOfflineStore class

ODataOfflineStore(Context) constructor

allocateNavigationProperties(ODataEntity) method

allocateProperties(ODataEntity, PropMode) method

closeStore() method

determineEntitySet(String) method

determineEntityType(String) method

determineODataType(String, Mode) method

executeCreateEntity(ODataEntity, String, Map< String, String >) method

executeDeleteEntity(String, String, Map< String, String >) method

executeDeleteEntity(ODataEntity, Map< String, String >) method

executeFunction(String, Map< String, String >) method

executePatchEntity(ODataEntity, Map< String, String >) method

executeReadEntity(String, Map< String, String >) method

executeReadEntity(ODataEntity, Map< String, String >) method

executeReadEntitySet(String, Map< String, String >) method

executeReadLink(String, Map< String, String >) method

executeReadLinkSet(String, Map< String, String >) method

executeReadPropertyComplex(String, Map< String, String >) method

executeReadPropertyPrimitive(String, Map< String, String >) method

executeReadPropertyRaw(String, Map< String, String >) method

executeRequest(ODataRequestParam) method

executeUpdateEntity(ODataEntity, Map< String, String >) method

flushQueuedRequests() method

getMetadata() method

getOfflineStoreListener() method

getRequestErrorListener() method

globalFini() method

globalInit() method

libraryVersion() method

openStoreAsync(ODataOfflineStoreOptions) method

openStoreSync(ODataOfflineStoreOptions) method

refresh() method

refresh(String) method

removeStore(Context, ODataOfflineStoreOptions) method

scheduleCreateEntity(ODataEntity, String, ODataRequestListener, Map< String, String >) method

scheduleDeleteEntity(ODataEntity, ODataRequestListener, Map< String, String >) method

scheduleDeleteEntity(String, String, ODataRequestListener, Map< String, String >) method

scheduleFlushQueuedRequests(ODataOfflineStoreFlushListener) method

scheduleFunction(String, ODataRequestListener, Map< String, String >) method

schedulePatchEntity(ODataEntity, ODataRequestListener, Map< String, String >) method

scheduleReadEntity(String, ODataRequestListener, Map< String, String >) method

scheduleReadEntity(ODataEntity, ODataRequestListener, Map< String, String >) method

scheduleReadEntitySet(String, ODataRequestListener, Map< String, String >) method

scheduleReadLink(String, ODataRequestListener, Map< String, String >) method

scheduleReadLinkSet(String, ODataRequestListener, Map< String, String >) method

scheduleReadPropertyComplex(String, ODataRequestListener, Map< String, String >) method

scheduleReadPropertyPrimitive(String, ODataRequestListener, Map< String, String >) method

scheduleReadPropertyRaw(String, ODataRequestListener, Map< String, String >) method

scheduleRefresh(ODataOfflineStoreRefreshListener) method

scheduleRefresh(String, ODataOfflineStoreRefreshListener) method

scheduleRequest(ODataRequestParam, ODataRequestListener) method

scheduleUpdateEntity(ODataEntity, ODataRequestListener, Map< String, String >) method

setOfflineStoreListener(ODataOfflineStoreListener) method

setRequestErrorListener(ODataOfflineStoreRequestErrorListener) method

ODataOfflineStoreOptions class

ODataOfflineStoreOptions() constructor

conversationManager variable

customCookies variable

customHeaders variable

definingRequests variable

enableHTTPS variable

enableRepeatableRequests variable

extraStreamParms variable

host variable

port variable

serviceRoot variable

storeEncryptionKey variable

storeName variable

urlSuffix variable

ODataOfflineStoreNotification enum

ODataOfflineStorePendingFlush variable

ODataOfflineStorePendingRefresh variable

ODataOfflineStoreState enum

ODataOfflineStoreClosed variable

ODataOfflineStoreDownloading variable

ODataOfflineStoreInitializing variable

ODataOfflineStoreOpen variable

ODataOfflineStoreOpening variable

ODataOfflineStorePopulating variable

ODataOfflineStoreFlushListener interface

offlineStoreFlushFailed(ODataOfflineStore, ODataException) method

offlineStoreFlushFinished(ODataOfflineStore) method

offlineStoreFlushStarted(ODataOfflineStore) method

offlineStoreFlushSucceeded(ODataOfflineStore) method

ODataOfflineStoreListener interface

offlineStoreNotification(ODataOfflineStore, ODataOfflineStoreNotification) method

offlineStoreOpenFailed(ODataOfflineStore, ODataException) method

offlineStoreOpenFinished(ODataOfflineStore) method

offlineStoreStateChanged(ODataOfflineStore, ODataOfflineStoreState) method

ODataOfflineStoreRefreshListener interface

offlineStoreRefreshFailed(ODataOfflineStore, ODataException) method

offlineStoreRefreshFinished(ODataOfflineStore) method

offlineStoreRefreshStarted(ODataOfflineStore) method

offlineStoreRefreshSucceeded(ODataOfflineStore) method

ODataOfflineStoreRequestErrorListener interface

offlineStoreRequestFailed(ODataOfflineStore, ODataRequestExecution, ODataException) method

OData API for Android

scheduleRequest Method

SAP Mobile Platform 3.0 OData SDK for Android

com.sap.smp.client package

odata package

exception package

ODataContractViolationException class

ODataContractViolationException.ErrorCode enum

getMessage() method

InvalidInputParameters variable

InvalidPayloadValue variable

InvalidResourcePath variable

InvalidStoreOptionValue variable

MissingBatchItems variable

MissingResourcePath variable

MissingStoreListener variable

MissingStoreOptions variable

MissingURL variable

ReadRequestInChangeSet variable

StoreAlreadyOpen variable

StoreClosed variable

StoreNotOpen variable

UnexpectedError variable

UnknownPayloadType variable

WrongPropertyType variable

WrongRequestMode variable

WrongResponseType variable

ODataContractViolationException(ErrorCode) constructor

ODataContractViolationException(ErrorCode, Throwable) constructor

ODataException class

ODataException.AbstractErrorCode interface

getMessage() method

ODataException(AbstractErrorCode) constructor

ODataException(AbstractErrorCode, Throwable) constructor

getMessage() method

errorCode variable

ODataNetworkException class

ODataNetworkException.ErrorCode enum

getMessage() method

CacheError variable

InternalError variable

NetworkError variable

ResponseError variable

ODataNetworkException(ErrorCode) constructor

ODataNetworkException(ErrorCode, Throwable) constructor

ODataParserException class

ODataParserException.ErrorCode enum

getMessage() method

DataDeserializationError variable

DataSerializationError variable

InternalError variable

MetadataDeserializationError variable

ODataErrorDeserializationError variable

ValidationError variable

ODataParserException(ErrorCode) constructor

ODataParserException(ErrorCode, String) constructor

ODataParserException(ErrorCode, String, Throwable) constructor

ODataParserException(ErrorCode, Throwable) constructor

getMessage() method

impl package

ODataCollectionDefaultImpl class

ODataCollectionDefaultImpl(String, String) constructor

getResourcePath() method

getTitle() method

ODataDurationDefaultImpl class

ODataDurationDefaultImpl() constructor

addTo(Calendar) method

addTo(Date) method

compareTo(ODataDuration) method

equals(Object) method

getDays() method

getHours() method

getMinutes() method

getMonths() method

getSeconds() method

getYears() method

hashCode() method

isNegative() method

setDays(int) method

setHours(int) method

setMinutes(int) method

setMonths(int) method

setNegative(boolean) method

setSeconds(BigDecimal) method

setYears(int) method

subtractFrom(Calendar) method

subtractFrom(Date) method

toString() method

ODataEntityDefaultImpl class

ODataEntityDefaultImpl(String) constructor

getEditMediaLink() method

getEditResourcePath() method

getEntityType() method

getEtag() method

getMediaContentType() method

getMediaLink() method

getNavigationProperty(String) method

getNavigationPropertyNames() method

getProperties() method

getResourcePath() method

isMediaEntry() method

setEditResourcePath(String) method

setEtag(String) method

setMediaLink(String, URL, URL) method

setNavigationProperty(String, ODataNavigationProperty) method

setResourcePath(String) method

setResourcePath(String, String) method

ODataEntitySetDefaultImpl class

ODataEntitySetDefaultImpl(int, String, Set< String >) constructor

getCount() method

getDeletedEntities() method

getDeltaPath() method

getEntities() method

getNextResourcePath() method

getResourcePath() method

setEntities(List< ODataEntity >) method

setNextResourcePath(String) method

setResourcePath(String) method

ODataErrorDefaultImpl class

ODataErrorDefaultImpl(String, String) constructor

getCode() method

getMessage() method

ODataGuidDefaultImpl class

guidAsBinary() method

guidAsString32() method

guidAsString36() method

initWithBinary(byte[]) method

initWithString32(String) method

initWithString36(String) method

ODataLinkDefaultImpl class

ODataLinkDefaultImpl(String) constructor

getResourcePath() method

ODataLinkListDefaultImpl class

ODataLinkListDefaultImpl() constructor

ODataLinkListDefaultImpl(List< ODataLink >) constructor

getLinks() method

ODataNavigationPropertyDefaultImpl class

ODataNavigationPropertyDefaultImpl() constructor

equals(Object) method

getAssociationResourcePath() method

getNavigationContent() method

getNavigationType() method

hashCode() method

hasNavigationInline() method

setAssociationResourcePath(String) method

setNavigationContent(Object) method

toString() method

ODataPayloadDefaultImpl class

ODataPropMapDefaultImpl class

ODataPropertyDefaultImpl class

ODataPropertyDefaultImpl(String) constructor

ODataPropertyDefaultImpl(String, Object) constructor

getName() method

getValue() method

isComplex() method

setValue(Object) method

toString() method

ODataRawValueDefaultImpl class

ODataRawValueDefaultImpl(String) constructor

getValue() method

metadata package

impl package

AnnotationNameDefaultImpl class

AnnotationNameDefaultImpl(String, String) constructor

equals(Object) method

getName() method

getNamespace() method

hashCode() method

ODataMetaComplexTypeDefaultImpl class

ODataMetaComplexTypeDefaultImpl(Map< String, ODataMetaProperty >) constructor

getProperty(String) method

getPropertyNames() method

ODataMetaEntityContainerDefaultImpl class

ODataMetaEntityContainerDefaultImpl(Map< String, ODataMetaFunctionImport >, Map< String, ODataMetaEntitySet >, Map< AnnotationName, String >) constructor

getAnnotation(AnnotationName) method

getAnnotation(String, String) method

getAnnotationNames() method

getEntitySetNames() method

getFunctionImport(String) method

getFunctionImportNames() method

getMetaEntitySet(String) method

ODataMetaEntitySetDefaultImpl class

ODataMetaEntitySetDefaultImpl(String, String, Map< AnnotationName, String >) constructor

getAnnotation(AnnotationName) method

getAnnotation(String, String) method

getAnnotationNames() method

getEntityType() method

getName() method

ODataMetaEntityTypeDefaultImpl class

ODataMetaEntityTypeDefaultImpl(Map< String, ODataMetaProperty >, String, boolean, Map< String, ODataMetaNavigationProperty >, Map< AnnotationName, String >) constructor

getAnnotation(AnnotationName) method

getAnnotation(String, String) method

getAnnotationNames() method

getKeyPropertyNames() method

getName() method

getNavigationProperty(String) method

getNavigationPropertyNames() method

getProperty(String) method

getPropertyNames() method

isMediaEntity() method

ODataMetaFunctionImportDefaultImpl class

ODataMetaFunctionImportDefaultImpl(String, String, boolean, String, String, Map< String, ODataMetaFunctionParameter >, Map< AnnotationName, String >) constructor

getAnnotation(AnnotationName) method

getAnnotation(String, String) method

getAnnotationNames() method

getCallMethod() method

getName() method

getParameter(String) method

getParameterNames() method

getReturnEntitySetName() method

getReturnTypeName() method

isReturnCollection() method

ODataMetaFunctionParameterDefaultImpl class

ODataMetaFunctionParameterDefaultImpl(String, String, boolean, ParameterMode, Map< AnnotationName, String >, Map< String, String >) constructor

getAnnotation(AnnotationName) method

getAnnotation(String, String) method

getAnnotationNames() method

getFacet(String) method

getFacetNames() method

getMode() method

getName() method

getTypeName() method

isCollection() method

ODataMetaNavigationPropertyDefaultImpl class

ODataMetaNavigationPropertyDefaultImpl(String, String, boolean) constructor

getName() method

getTargetEntityType() method

isEntitySet() method

ODataMetaPropertyDefaultImpl class

ODataMetaPropertyDefaultImpl(String, EDMType, String, boolean, Map< AnnotationName, String >, Map< String, String >) constructor

getAnnotation(AnnotationName) method

getAnnotation(String, String) method

getAnnotationNames() method

getFacet(String) method

getFacetNames() method

getName() method

getType() method

getTypeName() method

isKey() method

ODataMetadataDefaultImpl class

ODataMetadataDefaultImpl(Set< String >, Map< String, ODataMetaEntityType >, Map< String, ODataMetaComplexType >, Map< String, ODataMetaEntityContainer >, String) constructor

getLatestResourcePath() method

getMetaComplex(String) method

getMetaComplexNames() method

getMetaEntity(String) method

getMetaEntityContainer(String) method

getMetaEntityContainerNames() method

getMetaEntityNames() method

getMetaNamespaces() method

getResourcePath() method

getXml() method

AnnotationName interface

getName() method

getNamespace() method

ODataMetaComplexType interface

getProperty(String) method

getPropertyNames() method

ODataMetaEntityContainer interface

getAnnotation(AnnotationName) method

getAnnotation(String, String) method

getAnnotationNames() method

getEntitySetNames() method

getFunctionImport(String) method

getFunctionImportNames() method

getMetaEntitySet(String) method

ODataMetaEntitySet interface

getAnnotation(AnnotationName) method

getAnnotation(String, String) method

getAnnotationNames() method

getEntityType() method

getName() method

ODataMetaEntityType interface

getAnnotation(AnnotationName) method

getAnnotation(String, String) method

getAnnotationNames() method

getKeyPropertyNames() method

getName() method

getNavigationProperty(String) method

getNavigationPropertyNames() method

getProperty(String) method

getPropertyNames() method

isMediaEntity() method

ODataMetaFunctionImport interface

getAnnotation(AnnotationName) method

getAnnotation(String, String) method

getAnnotationNames() method

getCallMethod() method

getName() method

getParameter(String) method

getParameterNames() method

getReturnEntitySetName() method

getReturnTypeName() method

isReturnCollection() method

ODataMetaFunctionParameter interface

ODataMetaFunctionParameter.ParameterMode enum

IN variable

INOUT variable

OUT variable

getAnnotation(AnnotationName) method

getAnnotation(String, String) method

getAnnotationNames() method

getFacet(String) method

getFacetNames() method

getMode() method

getName() method

getTypeName() method

isCollection() method

ODataMetaNavigationProperty interface

getName() method

getTargetEntityType() method

isEntitySet() method

ODataMetaProperty interface

ODataMetaProperty.EDMType enum

EDMType(String) constructor

fromString(String) method

getText() method

Binary variable

Boolean variable

Byte variable

Complex variable

DateTime variable

DateTimeOffset variable

Decimal variable

Double variable

Guid variable

Int16 variable

Int32 variable

Int64 variable

Null variable

SByte variable

Single variable

String variable

text variable

Time variable

getAnnotation(AnnotationName) method

getAnnotation(String, String) method

getAnnotationNames() method

getFacet(String) method

getFacetNames() method

getName() method

getType() method

getTypeName() method

isKey() method

ODataMetadata interface

getLatestResourcePath() method

getMetaComplex(String) method

getMetaComplexNames() method

getMetaEntity(String) method

getMetaEntityContainer(String) method

getMetaEntityContainerNames() method

getMetaEntityNames() method

getMetaNamespaces() method

getResourcePath() method

getXml() method

store package

impl package

ODataRequestChangeSetDefaultImpl class

add(ODataRequestParamSingle) method

get(int) method

size() method

ODataRequestParamBatchDefaultImpl class

add(ODataRequestBatchItem) method

get(int) method

getCustomTag() method

setCustomTag(String) method

size() method

ODataRequestParamSingleDefaultImpl class

getContentID() method

getCustomTag() method

getEtag() method

getMode() method

getOptions() method

getPayload() method

getResourcePath() method

setContentID(String) method

setCustomTag(String) method

setEtag(String) method

setMode(Mode) method

setOptions(Map< String, String >) method

setPayload(ODataPayload) method

setResourcePath(String) method

ODataResponseBatchDefaultImpl class

ODataResponseBatchDefaultImpl(List< ODataResponseBatchItem >) constructor

getCustomTag() method

getHeaders() method

getResponses() method

isBatch() method

ODataResponseChangeSetDefaultImpl class

ODataResponseChangeSetDefaultImpl(List< ODataResponseSingle >) constructor

getResponses() method

ODataResponseSingleDefaultImpl class

ODataResponseSingleDefaultImpl(Type, ODataPayload, Map< Headers, String >, String) constructor

getCustomTag() method

getHeaders() method

getPayload() method

getPayloadType() method

isBatch() method

ODataRequestBatchItem interface

ODataRequestChangeSet interface

add(ODataRequestParamSingle) method

get(int) method

size() method

ODataRequestExecution interface

ODataRequestExecution.Status enum

Canceled variable

Complete variable

Error variable

Initialized variable

InProgress variable

cancelExecution() method

getRequest() method

getResponse() method

getStatus() method

getUniqueId() method

setResponse(ODataResponse) method

ODataRequestListener interface

requestCacheResponse(ODataRequestExecution) method

requestFailed(ODataRequestExecution, ODataException) method

requestFinished(ODataRequestExecution) method

requestServerResponse(ODataRequestExecution) method

requestStarted(ODataRequestExecution) method

ODataRequestParam interface

getCustomTag() method

setCustomTag(String) method

ODataRequestParamBatch interface

add(ODataRequestBatchItem) method

get(int) method

size() method

ODataRequestParamSingle interface

ODataRequestParamSingle.Mode enum

getHttpMethod() method

getMode(String) method

Create variable

Patch variable

Read variable

Update variable

ODataRequestParamSingle.Options enum

IgnoreCache variable

UseCache variable

getContentID() method

getEtag() method

getMode() method

getOptions() method

getPayload() method

getResourcePath() method

setContentID(String) method

setEtag(String) method

setMode(Mode) method

setOptions(Map< String, String >) method

setPayload(ODataPayload) method

setResourcePath(String) method

ODataResponse interface

ODataResponse.Headers enum

Headers(String) constructor

Code variable

ETag variable

Location variable

value variable

getCustomTag() method

getHeaders() method

isBatch() method

ODataResponseBatch interface

getResponses() method

ODataResponseBatchItem interface

ODataResponseChangeSet interface

getResponses() method

ODataResponseSingle interface

getPayload() method

getPayloadType() method

ODataStore interface

ODataStore.PropMode enum

Keys variable

Mandatory variable

Optional variable

allocateNavigationProperties(ODataEntity) method

allocateProperties(ODataEntity, PropMode) method

determineEntitySet(String) method

determineEntityType(String) method

determineODataType(String, Mode) method

getMetadata() method

ODataStoreAsync interface

scheduleCreateEntity(ODataEntity, String, ODataRequestListener, Map< String, String >) method

scheduleDeleteEntity(ODataEntity, ODataRequestListener, Map< String, String >) method

scheduleDeleteEntity(String, String, ODataRequestListener, Map< String, String >) method

scheduleFunction(String, ODataRequestListener, Map< String, String >) method

schedulePatchEntity(ODataEntity, ODataRequestListener, Map< String, String >) method

scheduleReadEntity(String, ODataRequestListener, Map< String, String >) method

scheduleReadEntity(ODataEntity, ODataRequestListener, Map< String, String >) method

scheduleReadEntitySet(String, ODataRequestListener, Map< String, String >) method

scheduleReadLink(String, ODataRequestListener, Map< String, String >) method

scheduleReadLinkSet(String, ODataRequestListener, Map< String, String >) method

scheduleReadPropertyComplex(String, ODataRequestListener, Map< String, String >) method

scheduleReadPropertyPrimitive(String, ODataRequestListener, Map< String, String >) method

scheduleReadPropertyRaw(String, ODataRequestListener, Map< String, String >) method

scheduleRequest(ODataRequestParam, ODataRequestListener) method

scheduleUpdateEntity(ODataEntity, ODataRequestListener, Map< String, String >) method

ODataStoreSync interface

executeCreateEntity(ODataEntity, String, Map< String, String >) method

executeDeleteEntity(ODataEntity, Map< String, String >) method

executeDeleteEntity(String, String, Map< String, String >) method

executeFunction(String, Map< String, String >) method

executePatchEntity(ODataEntity, Map< String, String >) method

executeReadEntity(String, Map< String, String >) method

executeReadEntity(ODataEntity, Map< String, String >) method

executeReadEntitySet(String, Map< String, String >) method

executeReadLink(String, Map< String, String >) method

executeReadLinkSet(String, Map< String, String >) method

executeReadPropertyComplex(String, Map< String, String >) method

executeReadPropertyPrimitive(String, Map< String, String >) method

executeReadPropertyRaw(String, Map< String, String >) method

executeRequest(ODataRequestParam) method

executeUpdateEntity(ODataEntity, Map< String, String >) method

ODataCollection interface

getResourcePath() method

getTitle() method

ODataDuration interface

addTo(Calendar) method

addTo(Date) method

getDays() method

getHours() method

getMinutes() method

getMonths() method

getSeconds() method

getYears() method

isNegative() method

setDays(int) method

setHours(int) method

setMinutes(int) method

setMonths(int) method

setNegative(boolean) method

setSeconds(BigDecimal) method

setYears(int) method

subtractFrom(Calendar) method

subtractFrom(Date) method

ODataEntity interface

getEditMediaLink() method

getEditResourcePath() method

getEntityType() method

getEtag() method

getMediaContentType() method

getMediaLink() method

getNavigationProperty(String) method

getNavigationPropertyNames() method

getProperties() method

getResourcePath() method

isMediaEntry() method

setEtag(String) method

setMediaLink(String, URL, URL) method

setNavigationProperty(String, ODataNavigationProperty) method

setResourcePath(String, String) method

ODataEntitySet interface

getCount() method

getDeletedEntities() method

getDeltaPath() method

getEntities() method

getNextResourcePath() method

getResourcePath() method

ODataError interface

getCode() method

getMessage() method

ODataGuid interface

guidAsBinary() method

guidAsString32() method

guidAsString36() method

ODataLink interface

getResourcePath() method

ODataLinkList interface

getLinks() method

ODataNavigationProperty interface

ODataNavigationProperty.Type enum

Empty variable

Entity variable

EntitySet variable

ResourcePath variable

getAssociationResourcePath() method

getNavigationContent() method

getNavigationType() method

hasNavigationInline() method

setAssociationResourcePath(String) method

setNavigationContent(Object) method

ODataPayload interface

ODataPayload.Type enum

Entity variable

EntitySet variable

Error variable

Link variable

LinkList variable

Metadata variable

None variable

Property variable

Raw variable

ODataPropMap interface

ODataProperty interface

getName() method

getValue() method

isComplex() method

setValue(Object) method

ODataRawValue interface

getValue() method

Deprecated API List

Developing with MAF Logon for Android

Architectural Overview

MAF Logon Task Flow

Executing Logon Operations

Data Requests

Handling Delegate Calls

Error Handling

Onboarding with SAP Mobile Place

SAP Mobile Place Workflow

HttpConversation Workflow

Developing Logon with Certificate Authentication

Developing Logon using Afaria Configuration

Developing Logon Using a Third-party Certificate Provider

API Reference

CertificateProvider Interface

getCertificate() Method

getStoredCertificate() Method

deleteStoredCertificate() Method

CertificateProviderListener Interface

onGetCertificateSuccess() Method

onGetCertificateFailure() Method

SAML Authentication

Logon Configuration Options

MAF Onboarding Scenarios

Logon APIs for Android

HttpConversation API

com.sap.smp.client package

httpc package

events package

IBaseEvent interface

getConversationContext() method

getManagerContext() method

getObserversByType(Class< T >) method

isCancelledExternally() method

ICancellationEvent interface

getResult() method

IReceiveEvent interface

IReceiveEvent.Util class

getResponseBody(final InputStreamReader) method

getContentType() method

getReader() method

getResponseHeaders() method

getResponseStatusCode() method

getResponseURL() method

getSendEvent() method

getStream() method

ISendEvent interface

getMethod() method

getRequestHeaders() method

getRequestParameters() method

getRequestURL() method

ITransmitEvent interface

getStream() method

getWriter() method

filters package

IRequestFilter interface

filter(ISendEvent, IRequestFilterChain) method

getDescriptor() method

IRequestFilterChain interface

filter() method

IResponseFilter interface

filter(IReceiveEvent, IResponseFilterChain) method

getDescriptor() method

RESTART_SIGNAL variable

IResponseFilterChain interface

filter() method

listeners package

IConnectionConfigurationListener< T > interface

onConfigRequired(ISendEvent) method

IConversationFlowListener interface

onCancellationByRequestFilter(ICancellationEvent) method

onCancellationByRequestListener(ICancellationEvent) method

onCancellationByResponseFilter(ICancellationEvent) method

onCommunicationError(IOException) method

onCompletion() method

onExternalCancellation(ICancellationEvent) method

onMaximumRestartsReached(ICancellationEvent) method

IRequestListener interface

onRequestBodySending(ITransmitEvent) method

onRequestHeaderSending(ISendEvent) method

IResponseListener interface

onResponseReceived(IReceiveEvent) method

ISSLSocketFactoryListener interface

onFactoryNeeded(ISendEvent, X509TrustManager[], X509KeyManager[]) method

observers package

IClientCertificateObserver interface

observeClientCertificate(String, String, URL, X509KeyManager, String) method

IObserver interface

utils package

BoundedBufferedReader class

BoundedBufferedReader(Reader) constructor

BoundedBufferedReader(Reader, int) constructor

readLine() method

ConstantConfigurationListener< T > class

ConstantConfigurationListener(T) method

onConfigRequired(ISendEvent) method

EmptyFlowListener class

onCancellationByRequestFilter(ICancellationEvent) method

onCancellationByRequestListener(ICancellationEvent) method

onCancellationByResponseFilter(ICancellationEvent) method

onCommunicationError(IOException) method

onCompletion() method

onExternalCancellation(ICancellationEvent) method

onMaximumRestartsReached(ICancellationEvent) method

MultipartRequestFacade class

MultipartRequestFacade.FormDataParameters class

FormDataParameters() constructor

FormDataParameters(String, Map< String, String >) constructor

FormDataParameters(String, String, Map< String, String >) constructor

fieldName variable

fileName variable

headers variable

MultipartRequestFacade.HttpRequestParameters class

HttpRequestParameters() constructor

HttpRequestParameters(HttpMethod, URL, Map< String, String >) constructor

headers variable

method variable

url variable

MultipartRequestFacade.PartType enum

FinishMultipart variable

FormData variable

PlainText variable

SimpleRequest variable

StartMultipart variable

MultipartRequestFacade.TypeSelector enum

FormData variable

HttpRequests variable

MultipartRequestFacade(TypeSelector) constructor

nextPart() method

onRequestBodySending(ITransmitEvent) method

onRequestHeaderSending(ISendEvent) method

onSendingBody(ITransmitEvent) method

onSettingFormDataParameters(FormDataParameters) method

onSettingSimpleRequestParameters(HttpRequestParameters) method

MultipartResponseFacade class

onPartReceived(int, String, Map< String, List< String >>, String) method

onResponseHandlingFinished() method

onResponseReceived(IReceiveEvent) method

SAPLoggerUtils class

logResponseDetails(IReceiveEvent, ClientLogger, ClientLogLevel, boolean, boolean) method

LOGGER_ID variable

CompositeTextBasedResponseDetector class

CompositeTextBasedResponseDetector(ITextBasedResponseDetector...) constructor

appendDetector(IHttpConversation, ITextBasedResponseDetector) method

performDetection(IReceiveEvent) method

HttpConversationManager class

HttpConversationManager.Setting enum

EXECUTOR variable

HOSTNAME_VERIFIER variable

KEY_MANAGER variable

PROXY_PROVIDER variable

SSL_SOCKET_FACTORY variable

TRUST_MANAGER variable

HttpConversationManager(Context) constructor

addFilter(IRequestFilter) method

addFilter(IResponseFilter) method

addKeyManager(X509KeyManager) method

addObserver(IObserver) method

addTrustManager(X509TrustManager) method

closeSettings(Setting...) method

copy() method

create(URL) method

getDefault() method

getDefaultTextBasedResponseDetector() method

getInitialDetector() method

getName() method

getRequestFilterChain() method

getResponseFilterChain() method

setDefault(HttpConversationManager) method

setDefaultFlowListener(IConversationFlowListener) method

setDefaultMaximumRestarts(int) method

setDefaultTextBasedResponseDetector(ITextBasedResponseDetector) method

setExecutor(Executor) method

setHostnameVerifierListener(IConnectionConfigurationListener< HostnameVerifier >) method

setName(String) method

setProxyProviderListener(IConnectionConfigurationListener< Proxy >) method

setSSLSocketFactoryListener(ISSLSocketFactoryListener) method

DEFAULT_MAX_RESTARTS variable

JsonContentResponseDetector class

performDetection(IReceiveEvent) method

SupportabilityUploaderImpl class

SupportabilityUploaderImpl(IHttpConversation, Context) constructor

send(Map< String, String >, InputStream, UploaderListener) method

XmlContentResponseDetector class

XmlContentResponseDetector(String...) constructor

performDetection(IReceiveEvent) method

HttpMethod enum

CONNECT variable

DELETE variable

GET variable

HEAD variable

MERGE variable

OPTIONS variable

PATCH variable

POST variable

PUT variable

TRACE variable

IContext interface

IContext.Scope enum

MANAGER variable

getName() method

getScope() method

getStateMap(String, boolean) method

IHttpConversation interface

addHeader(String, String) method

addParameter(String, String) method

cancel() method

getName() method

getTextBasedResponseDetector() method

isCancelled() method

setChunkSize(int) method

setContentLength(int) method

setFlowListener(IConversationFlowListener) method

setMaximumRestarts(int) method

setMethod(HttpMethod) method

setName(String) method

setRequestListener(IRequestListener) method

setResponseListener(IResponseListener) method

setTextBasedResponseDetector(ITextBasedResponseDetector) method

start() method

IManagerConfigurator interface

configure(HttpConversationManager) method

ITextBasedResponseDetector interface

performDetection(IReceiveEvent) method

HttpConvAuthFlows API

com.sap.smp.client package

httpc package

authflows package

oauth2 package

AbstractOAuth2BearerTokenWebFlowConfig class

AbstractOAuth2BearerTokenWebFlowConfig.OAuth2BearerTokenWebFlowConfigWrapper class

describeContents() method

getAuthorizationCodeParamName() method

getAuthorizationEndpointUrl() method

getClientId() method

getRedirectUri() method

getTokenEndpointUrl() method

writeToParcel(Parcel, int) method

CREATOR variable

accept(OAuth2ConfigVisitor< T >) method

createWrapper() method

getAuthorizationCodeParamName() method

getAuthorizationEndpointUrl() method

getClientId() method

getRedirectUri() method

getTokenEndpointUrl() method

OAuth2AccessTokenProxy interface

getAccessToken() method

OAuth2Config interface

accept(OAuth2ConfigVisitor< T >) method

OAuth2ConfigVisitor< T > interface

visit(AbstractOAuth2BearerTokenWebFlowConfig) method

observers package

IBasicAuthCredentialsObserver interface

observeCredentials(String, String, URL, UsernamePasswordToken) method

IOAuth2AccessTokenObserver interface

observeCredentials(String, String, URL, OAuth2Config, String) method

BasicAuthCancellation class

BasicAuthCancellation(boolean, Object) constructor

object variable

wasChallenge variable

CommonAuthFlowsConfigurator class

CommonAuthFlowsConfigurator(Context) constructor

configure(HttpConversationManager) method

supportBasicAuthUsing(UsernamePasswordProvider) method

supportOAuth2Using(OAuth2ConfigProvider) method

supportSaml2AuthUsing(SAML2ConfigProvider) method

OAuth2DeclinedResponseCancellation class

OAuth2DeclinedResponseCancellation(Object) constructor

object variable

SAML2Config class

SAML2Config(String, String, String) constructor

finishEndpoint variable

finishEndpointParam variable

header variable

UsernamePasswordToken class

UsernamePasswordToken(String, String) constructor

password variable

username variable

FilterDescriptors enum

BASIC_AUTH_REQF variable

BASIC_AUTH_RESPF variable

OAUTH2_REQF variable

SAML2_RESPF variable

OAuth2Cancellation enum

UNSUPPORTED_CONFIG variable

SAML2AuthCancellation enum

NO_CONFIG variable

OAuth2ConfigProvider interface

isAcceptedResponse(IReceiveEvent, String) method

provideAccessToken(ISendEvent) method

provideConfiguration(ISendEvent) method

SAML2ConfigProvider interface

onSAML2Challenge(IReceiveEvent) method

UsernamePasswordProvider interface

onCredentialsNeededForChallenge(IReceiveEvent) method

onCredentialsNeededUpfront(ISendEvent) method

Mobile Place API

com.sap.smp.client package

mobileplace package

AuthConfig class

accept(IConfigurationVisitor< T >) method

ConfigurationController class

ConfigurationController.CompletionListener class

onError(Throwable) method

onStartDownloading() method

onSuccess(IConfigurationParameters) method

ConfigurationController(Context) constructor

getConfigurationParameters(String, String, String, final CompletionListener) method

getConfigurationParameters(Context, final String, String, final CompletionListener) method

ConfigurationParametersFactory class

getConfigurationParameters(String) method

GenericConfig class

getAuthType() method

getConfigJSON() method

InvalidConfigurationParameters class

InvalidConfigurationParameters.JSONKeys enum

data variable

errorCode variable

message variable

getErrorDocuments() method

OAuth2Config class

getAuthorizationEndpont() method

getClientID() method

getGrantType() method

getScopes() method

getTokenEndpoint() method

Saml2Config class

getAuthHeaderName() method

getFinishEndpointRedirectParam() method

getFinishEndpointUri() method

UIBlocker class

block() method

unblock() method

UserInteraction class

askForEmailAddress(Context) method

ValidConfigurationParameters class

ValidConfigurationParameters.AuthJSONKeys enum

config variable

type variable

ValidConfigurationParameters.AuthType enum

parse(String, JSONObject) method

GENERIC variable

OAUTH2 variable

SAML2 variable

ValidConfigurationParameters.MainJSONKeys enum

auth variable

host variable

port variable

protocol variable

getAuthConfigs() method

getHost() method

getPort() method

getProtocol() method

IConfigurationParameters interface

IConfigurationVisitor< T > interface

visit(OAuth2Config) method

visit(Saml2Config) method

visit(GenericConfig) method

IInvalidConfigurationParameters interface

IInvalidConfigurationParameters.ErrorDocument class

IInvalidConfigurationParameters.ErrorDocument.Builder class

build() method

data(String) method

errorCode(String) method

message(String) method

getData() method

getErrorCode() method

getMessage() method

getErrorDocuments() method

IValidConfigurationParameters interface

getAuthConfigs() method

getHost() method

getPort() method

getProtocol() method

Supportability for Android

Logging and Tracing Overview

Implement Logging and Tracing in Android Native Application

Supportability API for Android

com.sap.smp.client package

supportability package

E2ETraceException class

E2ETraceException(String) constructor

E2ETraceException(String, Throwable) constructor

Supportability class

getClientLogger(Context, String) method

getClientLogManager(Context) method

getE2ETrace() method

getE2ETraceManager(Context) method

getInstance() method

ClientLogDestination enum

CONSOLE variable

FILESYSTEM variable

ClientLogLevel enum

ClientLogLevel(int) constructor

getGrade() method

isEnabled(ClientLogLevel) method

ALL variable

DEBUG variable

ERROR variable

FATAL variable

INFO variable

NONE variable

WARNING variable

E2ETraceLevel enum

E2ETraceLevel(int) constructor

getGrade() method

HIGH variable

LOW variable

MEDIUM variable

NONE variable

ClientLogEntry interface

ClientLogEntry.MessageType enum

JAVA variable

PLAIN variable

getApplication() method

getCorrelationId() method

getDate() method

getDCComponent() method

getException() method

getGUID() method

getLocation() method

getLogLevel() method

getMessage() method

getMessageCode() method

getMessageType() method

getRootContextId() method

getSourceName() method

getTimeZone() method

getTransactionId() method

getUser() method

ClientLogManager interface

getCorrelationId() method

getLogEntries() method

getLogEntriesForLogger(String) method

getLogger(String) method

getRawLogData(String) method

init(Context) method

setLogDestination(EnumSet< ClientLogDestination >) method

setLogDestination(EnumSet< ClientLogDestination >, String) method

setLogLevel(ClientLogLevel) method

setLogLevel(ClientLogLevel, String) method

setRootContextId(String) method

uploadClientLogs(Uploader, UploadListener) method

ClientLogger interface

getLogDestinations() method

getLogLevel() method

isDestinationSet(ClientLogDestination) method

log(ClientLogLevel, String) method

log(ClientLogLevel, String, Throwable) method

log(ClientLogLevel, String, TraceInfo) method

log(ClientLogLevel, String, Throwable, TraceInfo) method

logDebug(String) method

logDebug(String, Throwable) method

logDebug(String, TraceInfo) method

logDebug(String, Throwable, TraceInfo) method

logError(String) method

logError(String, Throwable) method

logError(String, TraceInfo) method

logError(String, Throwable, TraceInfo) method

logFatal(String) method

logFatal(String, Throwable) method

logFatal(String, TraceInfo) method

logFatal(String, Throwable, TraceInfo) method

logInfo(String) method

logInfo(String, Throwable) method

logInfo(String, TraceInfo) method

logInfo(String, Throwable, TraceInfo) method

logWarning(String) method

logWarning(String, Throwable) method

logWarning(String, TraceInfo) method

logWarning(String, Throwable, TraceInfo) method

E2ETrace interface

getE2ETraceLevel() method

startRequest() method

E2ETraceManager interface

getActiveTrace() method

getActiveTransaction() method

getE2ETraceLevel() method

init(Context) method

setE2ETraceLevel(E2ETraceLevel) method

startTransaction(String) method

uploadBTX(Uploader, UploadListener) method

E2ETraceRequest interface

E2ETraceRequest.RequestStatus enum

Started variable

endRequest() method

getCorrelationIDHttpHeader() method

getPassportHttpHeader() method

getStatus() method

getTraceInfo() method

getTransactionID() method

markReceived() method

markReceiving() method

markSending() method

markSent() method

setByteCountReceived(long) method

setByteCountSent(long) method

setDuration(long) method

setRequestHeaders(String) method

setRequestHeaders(Map< String, String >) method

setRequestLine(String) method

setResponseHeaders(String) method

setResponseHeaders(Map< String, String >) method

setReturnCode(String) method

E2ETraceStep interface

E2ETraceStep.StepStatus enum

Started variable

endStep() method

getRequests() method

getStatus() method

startRequest() method

E2ETraceTransaction interface

E2ETraceTransaction.TransactionStatus enum

Started variable

endTransaction() method

getActiveStep() method

getBTX() method

getStatus() method

startStep() method

TraceInfo interface

getCorrelationID() method

getTransactionID() method

UploadListener interface

onUploadFailure(UploadResult) method

onUploadSuccess() method

UploadResult interface

getHint() method

getResponseStatusCode() method

Uploader interface

send(Map< String, String >, InputStream, UploaderListener) method

UploaderListener interface

onFinished(boolean, UploadResult) method

ClientLog API for Android

com.sap.smp.client package

supportability package

log package

console package

ConsoleLogSerializer class

deSerialize(String) method

serialize(ClientLogEntry) method

ConsoleLogger class

getInstance() method

log(ClientLogEntry) method

file package

FileLogSerializer class

deSerialize(byte[]) method

isEncrypted() method

serialize(ClientLogEntryImpl) method

setEncrypted(boolean) method

FileLogger class

getInstance() method

getLogEntries(String, boolean) method

getLogFiles() method

getNextLogFileIndex() method

log(ClientLogEntryImpl) method

setContext(Context) method

uploadClientLogs() method

uploadFinished(boolean) method

FILE_AGE_MAX_DEF variable

FILE_COUNT_MAX_DEF variable

FILE_NAME_DEF variable

FILE_SIZE_MAX_DEF variable

fileAge variable

fileCount variable

fileName variable

fileSize variable

FileLoggerTask class

FileLoggerTask(Context, ClientLogEntryImpl) constructor

run() method

swithcToNewFile(File) method

E2ETrace API for Android

com.sap package

jdsr package

passport package

statistics package

util package

writer package

smp package

client package

supportability package

e2e package

btxmodel package

guid package

passport package

RequestTracingStatus enum

ActiveTransactionEnded variable

Allowed variable

NoActiveStep variable

NoActiveTransaction variable

Developing with Android Reusable UI Components

MAF Skinning

Dependencies and Project Setup

The MAF Skinning Mechanism

MAF Simple Controls

MAFLogViewer

MAFActionBar

MAFButton

MAFCheckBox

MAFDialog and MAFDialogWithProgressBar

MAFEditText

MAFFilterDialog

MAFImageView

MAFListActivity

MAFOptionMenu

MAFProgressBar

MAFProgressDialog

MAFRadioButton

MAFSearchBox

MAFSectionHeader

MAFSpinner

MAFSpinnerButton

MAFTextView

MAF Setting Screen

MAF Calendar

Dependencies and Project Setup

Creating Appointments and Implementing MAF Calendar Data Provider

Using the MAF Calendar UI Controls

List View

Month View

Combo View

Day View

Week View

Month Tablet View

Skinning Calendar Views

MAF Formatters

Dependencies and Project Setup

MAF Formatter Types

MAFDateTimeFormatter

MAFCurrencyFormatter

MAFAddressFormatter

MAF Tree View

MAF Locale-Aware Controls

Dependencies and Project Setup

The Controls

Currency Control

Phone Number Control

Address Control

Developing with the Android Extensibility Framework

Architectural Overview

Implementing an Extensible Application

Prerequisites

Sample Applications

Creating a New Project

Adding Dependencies

Defining the Extensibility XML

Initializing Logging and the MAF Core

Displaying Text

Adding Custom Code

Adding Custom Styling

Working with Data

Adding and Accessing Localized Text

Using Localization Key in Configuration

Implementation and Coding

Building MAF Core

Fully Metadata-Driven Apps

Mixing Coded and Metadata-Driven Tiles

Collaborating with MAF Extensibility Framework

Passive and Active Mode of the Framework

Using the MAF Extensibility Framework in Passive Mode

Using the MAF Extensibility Framework in Active Mode

Collaborating with MAF Extensibility Components

Data Layer

Data Component

Logic Component

UI Component

Activity Status

Technical Details

Generic Business Object

Extensibility Layout XML

Extensibility Configuration XSD

Tile Bindings

Tile Containers

Tile Definitions

Tile Layouts

List Management

Context Management

Global Context Management

Automatic and Explicit Context Updates

Responses to Context Update Events

Definitions of Events and Actions

Formatters

Amounts with Currency

Date and Time

Phone Number

Address

Custom Formatter

Functions

Use of Functions in Configuration

Data Source Adaptor

Extensibility Configuration Management

Application Configuration Profile Directory and Contents

Uploading Configuration Profiles

Logging and Tracing

Mobile Application Workbench

Features Not Supported

Running and Testing Android Applications

Deploying Android Applications

Installing Applications on the Device

Releasing Applications Through an App Marketplace or Enterprise App Store

Analyzing Logs and Debugging Errors on Android Devices

Windows Applications

Developing Windows Store and Windows Desktop Applications

Creating a Windows Store Project

Creating a Windows Desktop Project

Set SAP Mobile Platform SDK Binaries Location

Adding References for a Windows Store Project

Developing Windows Online OData Applications

Registering Devices and Connecting Users

Registration Process Flow

Initializing an Online Store

Read Operations

Making HTTP Get Requests from Whitelisted Connections

Binding Responses to UI Controls

Binding Responses to UI Controls Using LINQ

Perform Create, Update, Delete Operations

Create Operations

Update Operations

Delete Operations

Miscellaneous Operations

Function Imports

Logging Operations

OData APIs for Windows

OData Online Store API for Windows

SAP package

Data package

OData package

Online package

Store package

MemoryResponseMessage class

MemoryResponseMessage(int, System.Net.Http.Headers.HttpHeaders, byte[]) constructor

Dispose() method

Dispose(bool) method

GetHeader(string) method

GetStream() method

GetStreamAsync() method

SetHeader(string, string) method

Headers property

StatusCode property

ODataRequestExecution class

CancelExecution() method

RequestParameters property

Response property

Status property

UniqueId property

uniqueId variable

ODataRequestParameters class

ODataRequestParameters(string, RequestMode, SAP.Data.OData.IODataPayload) constructor

ODataStore class

ODataStore(string, EntityFormat) constructor

ODataStore(Uri, EntityFormat) constructor

AllocateNavigationProperties(IODataEntity) method

AllocateProperties(IODataEntity, PropertyCreationMode) method

DetermineEntitySet(string) method

DetermineEntityType(string) method

DetermineODataType(String, RequestMode) method

Dispose() method

Dispose(bool) method

OpenAsync(SAP.Net.Http.HttpClient) method

ScheduleCreateEntity(IODataEntity, string, Dictionary< string, string >) method

ScheduleDeleteEntity(IODataEntity, Dictionary< string, string >) method

ScheduleFunction(string, Dictionary< string, string >) method

SchedulePatchEntity(IODataEntity, Dictionary< string, string >) method

ScheduleReadEntity(string, Dictionary< string, string >) method

ScheduleReadEntity(IODataEntity, Dictionary< string, string >) method

ScheduleReadEntitySet(string, Dictionary< string, string >) method

ScheduleReadPropertyComplex(string, Dictionary< string, string >) method

ScheduleReadPropertyLink(string, Dictionary< string, string >) method

ScheduleReadPropertyLinkSet(string, Dictionary< string, string >) method

ScheduleReadPropertyPrimitive(string, Dictionary< string, string >) method

ScheduleReadPropertyRaw(string, Dictionary< string, string >) method

ScheduleRequest(OData.Store.IODataRequestParameters) method

ScheduleUpdateEntity(IODataEntity, Dictionary< string, string >) method

EntityFormat enumeration

Credentials property

Metadata property

entityFormat variable

ODataContractViolationException class

ODataContractViolationException(ExceptionErrorCode) constructor

ODataContractViolationException(ExceptionErrorCode, string) constructor

ODataContractViolationException(ExceptionErrorCode, string, Exception) constructor

ODataContractViolationException(ExceptionErrorCode, string, Exception, IODataError) constructor

ExceptionErrorCode enumeration

ODataEntity class

ODataEntity(string, Dictionary< string, IODataNavigationProperty >) constructor

IsOpen property

ODataEntitySet class

ODataMetadata class

ODataNavigationProperty class

NavigationContent property

NavigationType property

ODataNetworkException class

ODataNetworkException(ExceptionErrorCode) constructor

ODataNetworkException(ExceptionErrorCode, string) constructor

ODataNetworkException(ExceptionErrorCode, string, Exception) constructor

ODataNetworkException(ExceptionErrorCode, string, Exception, IODataError) constructor

ExceptionErrorCode enumeration

Payload property

ODataParserException class

ODataParserException(ExceptionErrorCode) constructor

ODataParserException(ExceptionErrorCode, string) constructor

ODataParserException(ExceptionErrorCode, string, Exception) constructor

ODataParserException(ExceptionErrorCode, string, Exception, IODataError) constructor

ExceptionErrorCode enumeration

ODataProperty class

ODataPropertyMap class

UrlParser class

UrlParser::UrlParserResult class

UrlParserResult(string, string, ODataType, string, string) constructor

EntitySetName property

EntityTypeName property

FunctionImportName property

PropertyName property

Type property

ParseUrl(IODataMetadata, string, RequestMode) method

Net package

Extensions package

HttpResponseMessageExtension class

EnsureSuccessStatusCodeWithResponse(this System.Net.Http.HttpResponseMessage) method

HttpRequestException class

GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext) method

Headers property

Response property

StatusCode property

StringResponse property

OData API for Windows

ScheduleRequest Method

SAP package

Data package

OData package

Metadata package

ODataAnnotationName class

ODataAnnotationName(string, string) constructor

Name property

Namespace property

annotationNamespace variable

name variable

ODataMetaComplexType class

ODataMetaComplexType(string, Dictionary< string, IODataMetaProperty >) constructor

Name property

this[string propertyName] property

properties variable

ODataMetaEntityContainer class

ODataMetaEntityContainer(string, Dictionary< string, IODataMetaEntitySet >, Dictionary< IODataAnnotationName, string >, Dictionary< string, IODataMetaFunctionImport >) constructor

GetAnnotation(IODataAnnotationName) method

GetAnnotation(string, string) method

GetMetaEntitySet(string) method

GetODataMetaFunctionImport(string) method

AnnotationNames property

EntitySetNames property

FunctionImportNames property

Name property

annotations variable

entitySets variable

functionImports variable

name variable

ODataMetaEntitySet class

ODataMetaEntitySet(string, string, Dictionary< IODataAnnotationName, string >) constructor

GetAnnotation(IODataAnnotationName) method

GetAnnotation(string, string) method

AnnotationNames property

EntityType property

Name property

annotations variable

entityType variable

name variable

ODataMetaEntityType class

ODataMetaEntityType(string, Dictionary< string, IODataMetaProperty >, Dictionary< string, IODataMetaNavigationProperty >, Dictionary< IODataAnnotationName, string >, IReadOnlyCollection< string >) constructor

GetAnnotation(IODataAnnotationName) method

GetAnnotation(string, string) method

GetNavigationProperty(string) method

AnnotationNames property

IsMediaEntity property

KeyPropertyNames property

Name property

NavigationPropertyNames property

PropertyNames property

this[string propertyName] property

annotations variable

isMediaEntity variable

keyPropertyNames variable

name variable

navigationProperties variable

properties variable

ODataMetaFunctionImport class

ODataMetaFunctionImport(string, string, string, string, bool, Dictionary< IODataAnnotationName, string >, Dictionary< string, IODataMetaFunctionParameter >) constructor

GetAnnotation(IODataAnnotationName) method

GetAnnotation(string, string) method

GetParameter(string) method

AnnotationNames property

CallMethod property

IsReturnCollection property

Name property

ParameterNames property

ReturnEntitySetName property

ReturnTypeName property

annotations variable

callMethod variable

isReturnCollection variable

name variable

parameters variable

returnEntitySetName variable

returnTypeName variable

ODataMetaFunctionParameter class

ODataMetaFunctionParameter(string, string, bool, ParameterMode, Dictionary< string, string >, Dictionary< IODataAnnotationName, string >) constructor

GetAnnotation(IODataAnnotationName) method

GetAnnotation(string, string) method

GetFacet(string) method

AnnotationNames property

FacetNames property

IsCollection property

Mode property

Name property

TypeName property

annotations variable

facetNames variable

isCollection variable

name variable

parameterMode variable

typeName variable

ODataMetaNavigationProperty class

ODataMetaNavigationProperty(string, string, bool) constructor

IsEntitySet property

Name property

TargetEntityType property

isEntitySet variable

name variable

targetEntityType variable

ODataMetaProperty class

ODataMetaProperty(string, EdmType, string, bool, Dictionary< string, string >, Dictionary< IODataAnnotationName, string >) constructor

GetAnnotation(IODataAnnotationName) method

GetAnnotation(string, string) method

GetFacet(string) method

AnnotationNames property

FacetNames property

IsKey property

Name property

Type property

TypeName property

annotations variable

facetNames variable

isKey variable

name variable

type variable

typeName variable

ODataMetadata class

ODataMetadata(IReadOnlyCollection< string >, Dictionary< string, IODataMetaEntityType >, Dictionary< string, IODataMetaComplexType >, Dictionary< string, IODataMetaEntityContainer >) constructor

GetMetaComplex(string) method

GetMetaEntity(string) method

GetMetaEntityContainer(string) method

LatestResoucePath property

MetaComplexNames property

MetaEntityContainerNames property

MetaEntityNames property

MetaNamespaces property

Resourcepath property

complexTypes variable

entityTypes variable

metaEntityContainers variable

metaNamespaces variable

IODataAnnotationName interface

Name property

Namespace property

IODataMetaComplexType interface

PropertyNames property

this[string propertyName] property

IODataMetaEntityContainer interface

GetAnnotation(IODataAnnotationName) method

GetAnnotation(string, string) method

GetMetaEntitySet(string) method

GetODataMetaFunctionImport(string) method

AnnotationNames property

EntitySetNames property

FunctionImportNames property

Name property

IODataMetaEntitySet interface

GetAnnotation(IODataAnnotationName) method

GetAnnotation(string, string) method

AnnotationNames property

EntityType property

Name property

IODataMetaEntityType interface

GetAnnotation(IODataAnnotationName) method

GetAnnotation(string, string) method

GetNavigationProperty(string) method

AnnotationNames property

IsMediaEntity property

KeyPropertyNames property

Name property

NavigationPropertyNames property

PropertyNames property

this[string propertyName] property

IODataMetaFunctionImport interface

GetAnnotation(IODataAnnotationName) method

GetAnnotation(string, string) method

GetParameter(string) method

AnnotationNames property

CallMethod property

IsReturnCollection property

Name property

ParameterNames property

ReturnEntitySetName property

ReturnTypeName property

IODataMetaFunctionParameter interface

GetAnnotation(IODataAnnotationName) method

GetAnnotation(string, string) method

GetFacet(string) method

AnnotationNames property

FacetNames property

IsCollection property

Mode property

Name property

TypeName property

IODataMetaNavigationProperty interface

IsEntitySet property

Name property

TargetEntityType property

IODataMetaProperty interface

GetAnnotation(IODataAnnotationName) method

GetAnnotation(string, string) method

GetFacet(string) method

AnnotationNames property

FacetNames property

IsKey property

Name property

Type property

IODataMetadata interface

GetMetaComplex(string) method

GetMetaEntity(string) method

GetMetaEntityContainer(string) method

LatestResoucePath property

MetaComplexNames property

MetaEntityContainerNames property

MetaEntityNames property

MetaNamespaces property

Resourcepath property

Store package

ODataRequestParameters class

ODataRequestParameters(string, RequestMode, SAP.Data.OData.IODataPayload) constructor

Mode property

Payload property

ResourcePath property

ODataRequestParametersSingle class

ODataRequestParametersSingle(string, RequestMode, SAP.Data.OData.IODataPayload) constructor

ContentID property

Etag property

Options property

ResponseType property

ResponseTypeName property

ODataResponse class

ODataResponse(string, bool, IReadOnlyDictionary< string, string >) constructor

CustomTag property

Headers property

IsBatch property

ODataResponseSingle class

ODataResponseSingle(IODataPayload, ODataType) constructor

Payload property

PayloadType property

payload variable

payloadType variable

IODataRequestBatchItem interface

IODataRequestChangeSet interface

Add(IODataRequestParametersSingle) method

Get(int) method

Size() method

parameterList property

IODataRequestExecution interface

CancelExecution() method

RequestParameters property

Response property

Status property

UniqueId property

IODataRequestParameterBatch interface

Add(IODataRequestBatchItem) method

Get(int) method

Size() method

batchItemList property

IODataRequestParameters interface

Mode property

Payload property

ResourcePath property

IODataRequestParametersSingle interface

ContentID property

Etag property

Options property

ResponseType property

ResponseTypeName property

IODataResponse interface

CustomTag property

Headers property

IsBatch property

IODataResponseBatch interface

Responses property

IODataResponseBatchItem interface

IODataResponseChangeSet interface

Responses property

IODataResponseSingle interface

Payload property

PayloadType property

IODataStore interface

AllocateNavigationProperties(IODataEntity) method

AllocateProperties(IODataEntity, PropertyCreationMode) method

DetermineEntitySet(String) method

DetermineEntityType(String) method

DetermineODataType(String, RequestMode) method

Metadata property

ODataEntity class

ODataEntity(string, Dictionary< string, IODataNavigationProperty >) constructor

DeepCopy() method

GetNavigationProperty(string) method

SetMediaLink(string, Uri, Uri) method

SetNavigationProperty(string, IODataNavigationProperty) method

SetResourcePath(string, string) method

ShallowCopy() method

EditMediaLink property

EditResourcePath property

Etag property

IsMediaEntry property

MediaContentType property

MediaLink property

NavigationPropertyNames property

PayloadType property

Properties property

ResourcePath property

TypeName property

editMediaLink variable

editResourcePath variable

etag variable

isMediaEntry variable

mediaContentType variable

mediaLink variable

navigationProperties variable

properties variable

resourcePath variable

ODataEntitySet class

ODataEntitySet() constructor

NotifyPropertyChanged(string) method

NextResourcePath property

PayloadType property

ResourcePath property

PropertyChanged event

ODataError class

ODataError(string, string) constructor

Code property

Message property

PayloadType property

code variable

message variable

ODataException class

ODataException(int) constructor

ODataException(int, string) constructor

ODataException(int, string, Exception) constructor

ODataException(int, string, Exception, IODataError) constructor

Error property

ErrorCode property

ODataLink class

PayloadType property

ResourcePath property

ODataLinkList class

ODataLinkList(IReadOnlyCollection< IODataLink >) constructor

Count property

Links property

PayloadType property

links variable

ODataNavigationProperty class

ODataNavigationProperty(bool, NavigationPropertyType, object) constructor

AssociationResourcePath property

HasNavigationInline property

NavigationContent property

NavigationType property

associationResourcePath variable

hasNavigationInline variable

navigationContent variable

navigationType variable

ODataProperty class

ODataProperty(string) constructor

ODataProperty(string, object) constructor

DeepCopy() method

ShallowCopy() method

IsComplex property

Name property

PayloadType property

Value property

name variable

value variable

ODataPropertyMap class

ODataPropertyMap(Dictionary< string, IODataProperty >) constructor

DeepCopy() method

NotifyPropertyChanged(string) method

Set(IODataProperty) method

ShallowCopy() method

PayloadType property

PropertyNames property

this[string path] property

PropertyChanged event

properties variable

ODataRawValue class

ODataRawValue(string) constructor

PayloadType property

Value property

PropertyChangedNotifier class

NotifyPropertyChanged(string) method

PropertyChanged event

IODataEntity interface

GetNavigationProperty(string) method

SetMediaLink(string, Uri, Uri) method

SetNavigationProperty(string, IODataNavigationProperty) method

SetResourcePath(string, string) method

EditMediaLink property

EditResourcePath property

Etag property

IsMediaEntry property

MediaContentType property

MediaLink property

NavigationPropertyNames property

Properties property

ResourcePath property

TypeName property

IODataEntitySet interface

NextResourcePath property

ResourcePath property

IODataError interface

Code property

Message property

IODataLink interface

ResourcePath property

IODataLinkList interface

Count property

Links property

IODataNavigationProperty interface

AssociationResourcePath property

HasNavigationInline property

NavigationContent property

NavigationType property

IODataPayload interface

PayloadType property

IODataProperty interface

DeepCopy() method

ShallowCopy() method

IsComplex property

Name property

Value property

IODataPropertyMap interface

DeepCopy() method

Set(IODataProperty) method

ShallowCopy() method

PropertyNames property

this[string path] property

IODataRawValue interface

Value property

SAML Authentication

SecureStore for Windows

LogonCore API for Windows

SAP package

Logon package

Core package

CertificateData class

CertificateBlob property

PfxKey property

LogonContext class

PasswordPolicy property

RegistrationContext property

LogonCore class

CancelRegistration() method

Dispose() method

GetObjectFromSecureStoreAsync(string) method

InitWithApplicationIdAsync(string) method

LockSecureStore() method

PersistRegistrationAsync(string, LogonContext) method

RegisterWithContextAsync(LogonContext) method

SetObjectInSecureStoreAsync(object, string) method

UnlockSecureStoreAsync(string) method

UnregisterAsync() method

ApplicationId property

CertificateProvider property

Logger property

LogonContext property

ShouldHandleSamlRequests property

State property

PropertyChanged event

LogonCoreState class

ApplicationId property

HasSecureStore property

IsExecutionInProgress property

IsRegistered property

IsSecureStoreOpen property

RegistrationContext class

ApplicationEndpointUrl property

ApplicationId property

BackendPassword property

BackendUserName property

CommunicatorId property

ConnectionData property

Domain property

FarmId property

IsHttps property

ResourcePath property

SecurityConfig property

ServerHost property

ServerPort property

PropertyChanged event

ICertificateProvider interface

DeleteStoredCertificateAsync() method

GetCertificateAsync() method

GetStoredCertificateAsync() method

SecureStore API for Windows

SAP package

SecureStore package

DataName class

Name property

Type property

DataVault class

ChangePasswordAsync(string) method

ChangePasswordAsync(string, string) method

CreateVaultAsync(string, string) method

CreateVaultAsync(string, string, DataVaultPasswordPolicy) method

DeleteValueAsync(string) method

DeleteVaultAsync(string) method

GetLockTimeout() method

GetStringAsync(string) method

GetValueAsync(string) method

GetVaultAsync(string) method

Lock() method

ResetLockTimeoutAsync() method

SetLockTimeoutAsync(uint) method

SetPasswordPolicyAsync(DataVaultPasswordPolicy) method

SetStringAsync(string, string) method

SetValueAsync(string, byte[]) method

UnlockAsync(string) method

VaultExistsAsync(string) method

DataNames property

Id property

IsDefaultPasswordUsed property

IsLocked property

Logger property

PasswordPolicy property

DataVaultPasswordPolicy class

DataVaultPasswordPolicy() constructor

ExpirationDays property

HasDigits property

HasLowercaseLetters property

HasSpecialLetters property

HasUppercaseLetter property

IsDefaultPasswordAllowed property

IsEnabled property

LockTimeout property

MinLength property

MinUniqueChars property

RetryLimit property

PropertyChanged event

IDataVaultException interface

InnerException property

Message property

Type property

Supportability for Windows

Logging and Tracing Overview

Implement Logging and Tracing in Windows Native Application

Upload Logs and Traces

Upload Client Logs

Upload BTX for End to End Trace

Additional Logging and Tracing Code Samples

Supportability API for Windows

SAP package

Supportability package

Logging package

ClientLogManager class

GetLogEntriesAsync() method

GetLogEntriesForLoggerAsync(string) method

GetLogger(string) method

GetRawLogDataAsync(string) method

SetLogDestination(int) method

SetLogDestination(int, string) method

SetLogLevel(ClientLogLevel) method

SetLogLevel(ClientLogLevel, string) method

SetRootContextId(string) method

UploadClientLogsAsync(IUploader) method

ClientLogger class

ClientLogger(string) constructor

GetLogEntriesAsync() method

Log(ClientLogLevel, string) method

LogDebug(string) method

LogError(string) method

LogFatal(string) method

LogInfo(string) method

LogWarning(string) method

SetRootContextId(string) method

SetTracing(bool) method

Destination property

LogLevel property

FileLoggingEventListener class

OnEventWritten(EventWrittenEventArgs) method

FileLoggingEventSource class

Critical(string, string) method

Debug(string, string) method

Error(string, string) method

Info(string, string) method

Warn(string, string) method

Log variable

IClientLogEntry interface

Application property

CorrelationId property

DCComponent property

EntryDateTime property

Guid property

Location property

Message property

MessageCode property

RootContextId property

Severity property

SourceName property

TimeZone property

TransactionId property

User property

IClientLogManager interface

GetLogEntriesAsync() method

GetLogEntriesForLoggerAsync(string) method

GetLogger(string) method

GetRawLogDataAsync(String) method

SetLogDestination(int) method

SetLogDestination(int, string) method

SetLogLevel(ClientLogLevel) method

SetLogLevel(ClientLogLevel, string) method

SetRootContextId(String) method

UploadClientLogsAsync(IUploader) method

IClientLogger interface

Log(ClientLogLevel, string) method

LogDebug(string) method

LogError(string) method

LogFatal(string) method

LogInfo(string) method

LogWarning(string) method

LogLevel property

Tracing package

BusinessTransaction class

BusinessTransaction() constructor

autoTraceCollection property

autoTraceCollectionSpecified property

clientHost property

ClientInformation property

ClientTraceList property

clientType property

clientTypeSpecified property

Guid property

id property

Items property

ItemsElementName property

name property

time property

TransactionStepList property

xmlVersion property

E2ETrace class

E2ETrace(IE2ETraceManager) constructor

EndTraceRequest(IE2ETraceRequest) method

StartTraceRequest() method

TraceLevel property

E2ETraceManager class

E2ETraceManager() constructor

EndTransaction(IE2ETraceTransaction) method

StartTransactionAsync(string) method

UploadBtxAsync(IUploader, IUploadListener) method

ActiveTrace property

ActiveTransaction property

Btx property

RequestTracingStatus property

TraceLevel property

E2ETraceRequest class

E2ETraceRequest(Message) constructor

EndRequest() method

MarkReceived() method

MarkReceiving() method

MarkSending() method

MarkSent() method

SetByteCountReceived(ulong) method

SetByteCountSent(ulong) method

SetDuration(ulong) method

SetRequestHeaders(string) method

SetRequestHeaders(IReadOnlyDictionary< string, string >) method

SetRequestLine(string) method

SetResponseHeaders(string) method

SetResponseHeaders(IReadOnlyDictionary< string, string >) method

SetReturnCode(string) method

CorrelationIdHttpHeader property

PassportHttpHeader property

TransactionId property

E2ETraceStep class

E2ETraceStep(TransactionStep) constructor

EndRequest(IE2ETraceRequest) method

EndStep() method

StartRequest() method

Requests property

E2ETraceTransaction class

E2ETraceTransaction(BusinessTransaction) constructor

EndStep(IE2ETraceStep) method

EndTransaction() method

StartStep() method

ActiveStep property

Btx property

Event class

eventtimestamp property

eventurl property

name property

ExtendedPassport class

ExtendedPassport(Guid, Guid, int) constructor

HeaderString property

Message class

Message() constructor

ClientTraceList property

CorrelationId property

dsrGuid property

Duration property

FirstByteReceived property

FirstByteSent property

id property

Items property

ItemsElementName property

LastByteReceived property

LastByteSent property

localPort property

name property

Passport property

protocol property

protocolSpecified property

Received property

RequestBody property

RequestHeader property

RequestLine property

ResponseFile property

ResponseHeader property

ReturnCode property

Sent property

TransactionId property

PerformanceCounterDataCollector class

IE_Private_Bytes property

IE_Processor_Time property

IE_Virtual_Bytes property

IE_Workingset property

Memory_Committed_Bytes property

Performance_Interval_ms property

Timer_start property

Timer_stop property

Total_Processor_Time property

TransactionStep class

TransactionStep() constructor

id property

Index property

Items property

ItemsElementName property

kcpu property

MessageList property

name property

reqType property

reqTypeSpecified property

RootContextId property

time property

traceflags property

ucpu property

clientTraceType class

clientTraceType() constructor

contenttype property

fileName property

format property

Value property

screenshot class

name property

IE2ETrace interface

EndTraceRequest(IE2ETraceRequest) method

StartTraceRequest() method

TraceLevel property

IE2ETraceLogEntry interface

IE2ETraceManager interface

EndTransaction(IE2ETraceTransaction) method

StartTransactionAsync(string) method

UploadBtxAsync(IUploader, IUploadListener) method

ActiveTrace property

ActiveTransaction property

Btx property

TraceLevel property

IE2ETraceRequest interface

EndRequest() method

MarkReceived() method

MarkReceiving() method

MarkSending() method

MarkSent() method

SetByteCountReceived(ulong) method

SetByteCountSent(ulong) method

SetDuration(ulong) method

SetRequestHeaders(string) method

SetRequestHeaders(IReadOnlyDictionary< string, string >) method

SetRequestLine(string) method

SetResponseHeaders(string) method

SetResponseHeaders(IReadOnlyDictionary< string, string >) method

SetReturnCode(string) method

CorrelationIdHttpHeader property

PassportHttpHeader property

TransactionId property

IE2ETraceStep interface

EndRequest(IE2ETraceRequest) method

EndStep() method

StartRequest() method

Requests property

IE2ETraceTransaction interface

EndStep(IE2ETraceStep) method

EndTransaction() method

StartStep() method

ActiveStep property

Btx property

IExtendedPassport interface

HeaderString property

SupportabilityFacade class

GetClientLogger(string) method

ClientLogManager property

E2ETrace property

E2ETraceManager property

Instance property

IUploadListener interface

OnUploadFailure(IUploadResult) method

OnUploadSuccess() method

IUploadResult interface

Hint property

ResponseStatusCode property

IUploader interface

SendAsync(IDictionary< String, String >, #if NETFX_CORE Windows.Storage.Streams.IInputStream#else Stream#endif, IUploaderListener) method

IUploaderListener interface

OnFinishedAsync(bool, IUploadResult) method

Running and Testing Windows Applications

Running and Testing Windows Desktop applications

Running and Testing Windows Store Applications

Deploying Windows Applications

Installing Windows Desktop Applications on the Device

Installing Windows Store Applications on a Windows Phone

Releasing Applications Through an App Marketplace or Enterprise App Store

Troubleshooting OData Application Development Issues

Kapsel Development

Developing Kapsel Applications

Setting Up the Development Environment

Creating an Application on the SAP Mobile Platform Server Using the Kapsel CLI

Configuring the Application in Management Cockpit

Defining Applications

Defining Back-End Connections

Defining Application Authentication

Kapsel Security Matrix

Creating an Apache Cordova Project

Project Settings

Including SAP Web IDE Assets into a Project

Creating an Application on Windows 8.1 and Window 8.1 Phone

Creating a Windows 8.1 Application

Creating a Windows Phone 8.1 Application

Using UI Development Frameworks

Configuring the Client for Authentication

Configuring the iOS Client for Basic Authentication over HTTP(S)

Configuring the iOS Client for Mutual Authentication over HTTP(S)

Configuring the Android Client for Basic Authentication over HTTP(S)

Configuring the Android Client for Mutual Authentication over HTTP(S)

Configuring the Windows 8.1 Client for Basic Authentication over HTTP(S)

Managing Application Registration Using Client Hub

Provisioning Applications Using Mobile Place

Provisioning Applications Using Afaria

Preparing the Kapsel Application for Afaria Provisioning

Kapsel Plugins

Using the Logon Plugin

Logon Plugin Overview

Adding the Logon Plugin

Configuring Default Values

Running the Logon Application on iOS

Removing Fields From the Registration Screen

Using the X.509 Certificate Provider Interface to Integrate with Third-Party Certificate Providers

Creating a Custom Certificate Provider

Creating a Resource to Display a UI View

Building and Running an iOS Project

Building and Running an Android Project

Enabling a CertificateProvider in an Application

CertificateProvider Interface Reference

iOS

onGetCertificateSuccess Method

onGetCertificateFailure Method

showUI Method

getCertificate Method

getStoredCertificate Method

deleteStoredCertificateWithError Method

setParameters Method

Android

onGetCertificateSuccess Method

onGetCertificateFailure Method

showUI Method

getCertificate Method

getStoredCertificate Method

deleteStoredCertificate Method

setParameters Method

CertificateProvider Samples

iOS Certificate Provider Sample

CertificateProvider.h

CertificateProviderDelegate Protocol

CertificateProvider Interface

X509FileCertificateProvider Code

Android Certificate Provider Sample

CustomCertificateProvider.java

CustomKeyManager.java

Localizing a CertificateProvider

Enabling Secure Onboarding Using SAML

Kapsel Logon API Reference

Logon namespace

applicationId member

core member

changePassword( onsuccess, onerror ) method

deletePasscodeManager( successCallback, errorCallback ) method

get( onsuccess, onerror, key ) method

getConfiguration( onsuccess, onerror, key ) method

init( successCallback, errorCallback, applicationId, [context], [logonView], [certificateProviderClassName] ) method

initPasscodeManager( successCallback, errorCallback, applicationId, [logonView] ) method

lock( onsuccess, onerror ) method

managePasscode( onsuccess, onerror ) method

refreshCertificate( onsuccess, onerror ) method

set( onsuccess, onerror, key, value ) method

showCertificateProviderScreen( onsuccess, onerror ) method

showRegistrationData( onsuccess, onerror ) method

unlock( onsuccess, onerror ) method

errorCallback( errorObject ) type

getSuccessCallback( value ) type

successCallback( context ) type

successCallbackNoParameters type

Source code

LogonController.js

Using the AppUpdate Plugin

AppUpdate Plugin Overview

Adding the AppUpdate Plugin

Kapsel AppUpdate API Reference

AppUpdate namespace

addEventListener( eventname, f ) method

reloadApp() method

removeEventListener( eventname, f ) method

reset() method

update() method

checking event

downloading event

error event

noupdate event

progress event

updateready event

Source code

appupdate.js

Using the AuthProxy Plugin

AuthProxy Plugin Overview

Adding the AuthProxy Plugin

Adding User Permissions to the Android Manifest File

Adding Cookies to a Request

Using the AuthProxy Plugin to Register With server-name

Generating Certificates and Keys

Kapsel AuthProxy API Reference

AuthProxy namespace

sap.AuthProxy.CertificateFromFile class

sap.AuthProxy.CertificateFromLogonManager class

sap.AuthProxy.CertificateFromStore class

ERR_CERTIFICATE_ALIAS_NOT_FOUND member

ERR_CERTIFICATE_FILE_NOT_EXIST member

ERR_CERTIFICATE_INVALID_FILE_FORMAT member

ERR_CLIENT_CERTIFICATE_VALIDATION member

ERR_DOMAIN_WHITELIST_REJECTION member

ERR_FILE_CERTIFICATE_SOURCE_UNSUPPORTED member

ERR_GET_CERTIFICATE_FAILED member

ERR_HTTP_TIMEOUT member

ERR_INVALID_PARAMETER_VALUE member

ERR_LOGON_MANAGER_CERTIFICATE_METHOD_NOT_AVAILABLE member

ERR_LOGON_MANAGER_CORE_NOT_AVAILABLE member

ERR_MISSING_PARAMETER member

ERR_NO_SUCH_ACTION member

ERR_SERVER_CERTIFICATE_VALIDATION member

ERR_SERVER_REQUEST_FAILED member

ERR_SYSTEM_CERTIFICATE_SOURCE_UNSUPPORTED member

ERR_UNKNOWN member

deleteCertificateFromStore( successCB, [errorCB], certificateKey ) method

generateODataHttpClient() method

get( url, header, successCB, errorCB, [user], [password], [timeout], [certSource] ) method

sendRequest( method, url, header, requestBody, successCB, errorCB, [user], [password], [timeout], [certSource] ) method

sendRequest2( method, url, header, requestBody, successCB, errorCB, [timeout], [authConfig] ) method

deleteCertificateSuccessCallback type

errorCallback( errorObject ) type

successCallback( serverResponse ) type

Source code

authproxy.js

Using the Barcode Scanner Plugin

Barcode Scanner Plugin Overview

Adding the Barcode Scanner Plugin

Barcode Scanner Samples

Barcode Scanner API Reference

encode( type, data, successCallback, errorCallback ) method

scan( successCallback, errorCallback ) method

Source code

barcodescanner.js

Using the End-to-End Trace Plugin

End-to-End Trace Plugin Overview

Adding the End-to-End Trace Plugin

Kapsel End-to-End Trace Plugin API Reference

sap namespace

E2ETrace namespace

E2ETrace#HIGH member

E2ETrace#LOW member

E2ETrace#MEDIUM member

E2ETrace#NONE member

endTrace() method

setTraceLevel() method

startTrace( [transactionName] ) method

uploadTrace() method

Source code

e2etrace.js

Using the EncryptedStorage Plugin

EncryptedStorage Plugin Overview

Adding the EncryptedStorage Plugin

Kapsel EncryptedStorage API Reference

EncryptedStorage namespace

COMPLEX_STRING_MAXIMUM_LENGTH member

ERROR_BAD_PASSWORD member

ERROR_DATAVAULT_ACCESS_ERROR member

ERROR_DATAVAULT_LOCKED member

ERROR_DB_ERROR member

ERROR_GREATER_THAN_MAXIMUM_SIZE member

ERROR_INVALID_PARAMETER member

ERROR_UNKNOWN member

SIMPLE_STRING_MAXIMUM_LENGTH member

clear( successCallback, errorCallback ) method

deleteStore( successCallback, errorCallback ) method

getItem( key, successCallback, errorCallback ) method

key( index, successCallback, errorCallback ) method

length( successCallback, errorCallback ) method

removeItem( key, successCallback, errorCallback ) method

setItem( key, value, successCallback, errorCallback ) method

errorCallback( errorCode ) type

getItemSuccessCallback( value ) type

keySuccessCallback( key ) type

lengthSuccessCallback( length ) type

successCallback type

Source code

encryptedstorage.js

Using the Logger Plugin

Logger Plugin Overview

Adding the Logger Plugin

Changing Client Log and Trace Settings

Testing Logging

Kapsel Logger API Reference

Logger namespace

Logger#DEBUG member

Logger#ERROR member

Logger#INFO member

Logger#WARN member

debug( message, [tag], [successCallback], [errorCallback] ) method

error( message, [tag], [successCallback], [errorCallback] ) method

getLogEntries( successCallback, errorCallback ) method

getLogLevel( successCallback, [errorCallback] ) method

info( message, [tag], [successCallback], [errorCallback] ) method

setLogLevel( level, [successCallback], [errorCallback] ) method

upload( successCallback, errorCallback ) method

warn( message, [tag], [successCallback], [errorCallback] ) method

Source code

logger.js

Using the Offline OData Plugin

Offline OData Plugin Overview

Adding the Offline OData Plugin

Kapsel Offline OData Plugin API Reference

OData namespace

stores member

applyHttpClient() method

createOfflineStore( properties, properties.name, properties.serviceRoot, properties.definingRequests, properties.host, properties.port, properties.urlSuffix, properties.https, properties.streamParams, properties.customHeaders, properties.customCookies, properties.enableRepeatableRequests ) method

removeHttpClient() method

request( request, request.headers, request.requestUri, request.method, request.data, successCallback, errorCallback ) method

requestError( error ) type

requestSuccess( response, response.statusCode, response.statusText, response.headers, response.body ) type

Source code

OData.js

OfflineStore.js

Using the Push Plugin

Push Plugin Overview

Provisioning Devices for Push

Provision the iOS Device for APNS

Generating a Certificate Request File

Creating an App ID

Configuring the App ID for Push Notifications

Creating the Provisioning File

Provision the Android Device for Push

Configuring Google Cloud Messaging Service

Provision the Windows Device for Push

Adding the Connected Services Option to the Project

Upgrading your Mobile Service to Receive Push Notifications

Adding the Push Notification Plugin

Configuring Push on SAP Mobile Platform Server

Android Push Notifications

Apple Push Notifications

Testing Push Notifications

Sample Application

Kapsel Push API Reference

Push namespace

checkForNotification( callback ) method

getBadgeNumber( callback ) method

registerForNotificationTypes( types, successCallback, errorCallback, notificationlistenerfunc, [senderId] ) method

resetBadge( callback ) method

setBadgeNumber( number, callback ) method

unregisterForNotificationTypes( callback ) method

callback( [devtok] ) type

Source code

push.js

Using the Settings Plugin

Settings Plugin Overview

Adding the Settings Plugin

Kapsel Settings API Reference

AppSettings namespace

getApplicationEndpoint( successCallback, errorCallback ) method

getConfigProperty( name, successCallback, errorCallback ) method

setConfigProperty( nameVals, successCallback, errorCallback ) method

Settings namespace

start( connectionData, successCallback, errorCallback ) method

Source code

appsettings.js

settings.js

SAP Fiori Client Plugins

Using the Online Application Plugin

Online Application Plugin Overview

Adding the Online Application Plugin

Using the Application Preferences Plugin

Application Preferences Plugin Overview

Adding the Application Preferences Plugin

Application Preferences API Reference

configurePreferencesScreen( preferencesUIData, [successCallback], [errorCallback] ) method

getPreferenceValue( key, [successCallback], [errorCallback] ) method

setPreferenceValue( key, value, [successCallback], [errorCallback] ) method

showPreferencesScreen( [successCallback], [errorCallback] ) method

Source code

apppreferences.js

Using the Cache Manager Plugin

Cache Manager Plugin Overview

Adding the Cache Manager Plugin

Cache Manager API Reference

CacheManager namespace

cacheinvalidated event

noviewerfound event

Source code

cachemanager.js

Using the Toolbar Plugin

Toolbar Plugin Overview

Adding the Toolbar Plugin

Toolbar API Reference

Toolbar namespace

SHOW_AS_ACTION_ALWAYS member

SHOW_AS_ACTION_IF_ROOM member

SHOW_AS_ACTION_NEVER member

SHOW_AS_ACTION_WITH_TEXT member

addItem( item, item.label, item.icon, item.showAsAction, callback ) method

clear( callback ) method

Source code

toolbar.js

SAP Fiori Client in SAP Mobile Platform

Requirements

Configuring Proxy Settings

Configuring the Script

Executing the Script

Configuring the SAP Fiori Client in SAP Mobile Platform

Application ID

User Agent String

Endpoint URL

First Use Tips Plugin Overview

Application Preferences (Settings)

Building the Application

SAP Fiori Client API Reference

FioriClient namespace

Source code

fioriclient.js

Developing a Kapsel Application With OData Online

Creating an OData Application

Creating an Application Connection

Getting Application Settings

Running and Testing Kapsel Applications

Client-side Debugging

Debugging in a Desktop Browser

Debugging on iOS

Running the Kapsel Application on Android

Running the Kapsel Application on iOS

Running the Kapsel Application on Windows

Package and Deploy Kapsel Applications

Generating and Uploading Kapsel App Files Using the Command Line Interface

Changing the Default Port

Preparing the Application for Upload to the Server

Uploading and Deploying Hybrid Apps

Deploying Hybrid Apps Using the REST API

Removing Kapsel Plugins

Mobile Application Workbench

Setting Up the Development Environment

Installing Mobile Application Workbench

Upgrading Mobile Application Workbench

Uninstalling Mobile Application Workbench

Application Configuration Profile

Application Configuration Profile Project

Perspectives

Project Explorer View

Outline View

Properties View

Wizards

Creating Application Configuration Profiles

Creating Binding Configurations

Creating Localized Text Configurations

Creating Style Configurations

Creating Tile Container Configurations

Creating Tile Layout Configurations

Exporting Application Configuration Profiles

Exporting Tile Layouts

Importing Application Configuration Profiles

Importing Localized Text Files

Importing Style Files

Importing Tile Layouts

Editors

Editing Application Configuration Profiles

Editing Bindings

Editing Localized Text

Editing Styles

Editing Tile Containers

Editing Tile Layouts

Tasks

Creating Application Configuration Profiles

Creating Binding, Tile, or Tile Container Files

Creating Localized Text Files

Creating Style Files

Exporting Application Configuration Profiles

Exporting Tile Layouts

Importing Application Configuration Profiles

Importing Tile Layouts

Importing Other Files

Validating Application Configuration Profiles

Agentry App Development

Setting Up the Development Environment for Agentry Toolkit

Installing the Eclipse IDE and Agentry Editor Plug-In

Configuring the Agentry Editor

Connector Studio and Data Tools Platform

Creating a SQL Connection Profile for the Agentry Connector Studio

Creating an OData Connection Profile for the Agentry Connector Studio

Java Projects

Creating Java Projects for Agentry Java API Development

File Associations and File Encoding

Configuring Eclipse File Associations for Agentry Projects

Configuring Eclipse File Encoding for Agentry Projects

Agentry OpenUI SDK for iOS Setup Overview

OpenUI for iOS Manual Xcode Project Setup

Branding iOS with the SMPAgentryClient Framework

Agentry OpenUI SDK for Android Setup Overview

Installing the ADT Bundle With Eclipse

Installing the ADT Plug-in to an Existing Eclipse Instance

SAP Mobile Platform Agentry OpenUI for Android Project Setup

Agentry OpenUI for Windows Setup Information

Installing the Agentry Test Environment

Agentry SAP Framework Installation Overview

Agentry SAP Framework Foundation Component

Installing Agentry SAP Framework Foundation

Creating the JavaBE.ini File for SAP Systems

Installing the Agentry ActiveX SDK

Developing Agentry Apps

Agentry Editor Eclipse Preferences

Agentry Editor and Eclipse Platform Overview

The Agentry Perspective in Eclipse

Project Explorer View

Properties View

Diagram View

Dependency View

Trash Bin View

Problems View

Agentry Views Outside of the Agentry Perspective

The Data Tools Platform: Development Tools

The Java Perspective

Searching Agentry Application Projects

Agentry Application Projects: Creating, Managing, and Publishing

Creating a New Agentry Application Project

Agentry Application Export, Import, and Comparison Introduction

Import Functionality Overview

Importing a New Agentry Project Into the Eclipse Workspace

Compare and Import Into an Agentry Application Project

Export Functionality Overview

Exporting Agentry Application Project Definitions

Exporting Agentry Application Project Differences

Publishing Applications from the Agentry Editor

Publishing to Development

Publishing to Production

Introduction to Definition Tags

Tagging: Creating New Public Tags

Tagging: Applying Public Tags to Definitions

Introduction to Team Configuration

Team Configuration: Share Repository Requirements and Operations

Update Conflicts and Conflict Resolution

Share Operation: Creating a Share Repository

Share Operation: Checking Out (Importing) From a Share

Share Operation: Committing Changes to the Share Repository

Share Operation: Updating From the Tip Share Repository Revision

Share Operation: Reverting to a Previous Share Revision

Overview of Mobile Northwind Sample Application

Target Paths and the Property Browser

Property Browser Details: Object-Related Options

Property Browser Details: Screen-Related Options

Property Browser Details: Complex Table-Related Options

Property Browser Details: Data Table-Related Options

Target Path: Selecting an Object By Property Value

Target Path: Selecting All Nested Collections

Rules: An Introduction

Rule Context

Rule Data Types

Rule Editor Introduction

Creating Rule Definitions

Testing Rules in the Rule Editor

Agentry Data Markup Language

SDML Syntax and Data Tag Expansion

Agentry Data Definitions Overview

Data Synchronization Overview: The Exchange Data Model

Data Synchronization: Data Filtering Overview

Object Development Concepts and Considerations

Object Properties Concepts and Considerations

Object Data Structure Concepts

Object Data Synchronization: Fetches

Object Read Step Concepts

Object Read Step Development Considerations

Fetch Development Using the Exchange Data Model

Agentry User Interface Definitions Overview

Client User Interface Considerations and Guidance

Security Related Development Overview

Defining Client-Side Data Encryption

Securing Attachments on iOS Client Devices

Configuring User Lockout for Failed Login Attempts

Transaction Authentication/Electronic Signature Support

Defining Transaction Authentication

Attached Documents and File Transfer: Key Concepts

Developing File Transfer and Attached Documents: Process Overview

Defining the File Object

Defining the Download Logic for File Transfer

Defining the User Interface for Attached Documents

Defining Locally Attached Documents Functionality

Agentry Language Reference

Application Level Definitions Overview

Application Definition

Module

Data Table

SQL Data Table Synchronization Components

OData Data Table Synchronization Components

HTTP-XML Data Table Synchronization Components

HTTP Request Argument

HTTP Request Response Mapping

Java Virtual Machine Data Table Synchronization Components

Complex Table

Complex Table Fields

Complex Table Indexes

SQL Complex Table Synchronization Components

Java Complex Table Synchronization Components

OData Complex Table Synchronization Components

HTTP-XML Complex Table Synchronization Components

HTTP Request Argument

HTTP Request Response Mapping

Transmit Configuration

System Connection

Validate User Request

Validate User Request Argument

Validate User Request Response Mapping

Global

Style

Image

Module-Level Data Definitions Overview

Object

Object Read Step

Object Property

Transaction

Transaction Authentication

Transaction Type: Add

Transaction Type: Edit

Transaction Type: Delete

Transaction Type: Complex Table Change

Transaction Type: Data Table Change

Transaction Validation Rule

Transaction Validation Rule Properties

Transaction Server Data State Steps

Transaction Server Update Step

Transaction Error Handling Steps

Fetch

Fetch Validation Rule

Fetch Validation Rule Properties

Fetch Client Exchange Step

Fetch Server Exchange Step

Fetch Removal Step

Transaction and Fetch Properties

Property Data Types

Boolean Property Type

Collection Property Type

Complex Table Selection Property Type

Data Table Selection Property Type

Date Property Type

Date And Time Property Type

Decimal Number Property Type

Duration Property Type

External Data Property Type

Identifier Property Type

Image

Integral Number Property Type

Location Property Type

Object Property Type

Signature Property Type

String Property Type

Time Property Type

Push

Push Retrieval Step

Push Removal Step

Push Read Step

Push Response Step

Push Error Handling Step

Service Event

Service Event Type: Poll With Step

Service Event Type: Java Callback

Service Event Type: HTTP-XML Message Received

HTTP-XML Service Event Message Mapping

Service Event Type: OData Message Received

OData Service Event Message Mapping

Service Event Type: File System Monitor

File System Monitor Service Event Document Mapping

Step

Step Type: SQL Query

Step Type: Java Steplet

Step Type: XML via HTTP

XML via HTTP Step Request Argument

XML via HTTP Step Response Mapping

Step Type: OData

Step Type: File Command Line Step

Step Type: File Document Management Step

Document Mapping

Module-Level User Interface Definitions Overview

User Interface Definition Types

Screen Set

Platform

List Screen

List Screen Column

Detail Screen

Button

Detail Screen Fields

Detail Screen Field Edit Types

Field Edit Type - Property Data Type Cross Reference

Field Definitions With Edit Type-Specific Attributes

Barcode Scan

Button Field Edit Type

Calendar View

Complex Table Drop Down

Complex Table List

Complex Table Search

Complex Table Tree

Data Table Selection

Embedded Image Field

Image Cell

External Field - ActiveX Control

HTML

Domain and URL Parameter

Image Capture

List Tile View

Tile Filter

List Selection

List View

List View Column

Password Validation

Tile Edit

Tile Display

Detail Screen Fields With Implicit Edit Types

Signature

Action

Action Step

Action Step Type: Apply

Action Step Type: Exit Application

Action Step Type: External Field Command

Action Step Type: List Selection

Action Step Type: Message

Action Step Type: Navigation

Action Step Type: Open URL

Action Step Type: Print Report

Action Step Type: Save Tile Transactions

Action Step Type: SubAction

Action Step Type: Transaction

Action Step Type: Transmit

Action Step Type: Windows Command

Report

Report Column

Rule Function Terms Overview

Conversion Functions for Rules

@FROM_DECIMAL_NUMBER

@FROM_INTEGRAL_NUMBER

@FROM_STRING

@FROM_SIG_DECIMAL_NUMBER

@FROM_PROPERTY

Logical Functions for Rules

@AND

@CASE

@CASE_INT

@CASE_STRING

@EQBOOL

@EQDEC

@EQNUM

@EQSTR

@GT

@GTDEC

@GTEQ

@GTEQDEC

@IF

@LT

@LTDEC

@LTEQ

@LTEQDEC

@NAND

@NOR

@NOT

@OR

@XOR

Mathematical Functions for Rules

@ABS

@DIFF

@DISTANCE

@DIV

@FORMAT_DECIMAL

@MAX

@MIN

@MOD

@PARSE_FORMATTED_DECIMAL

@PERCENT

@PRECISION

@PROD

@RANGE_LIMIT

@ROUND

@SIGN

@SIGNIFICANT_DIGITS

@SQRT

@SUM

@TOTAL

@TRUNC

Property Functions for Rules

@COLLECTION_FIND

@COLLECTION_FIND_BY_DEC

@COLLECTION_FIND_BY_NUM

@COLLECTION_FIND_BY_STR

@COLLECTION_MAX

@COLLECTION_MIN

@COUNT

@CURRENTVALUE

@FILE_CHANGED

@FILE_EXTENSION

@FILE_NAME

@FILE_PATH

@FILE_PATH_AND_NAME

@FILE_SIZE

@IS_SPECIAL_VALUE

@IS_VALID_DECIMAL_NUMBER

@LASTSCANVALUE

@MEMBER

@NEEDS_XMIT

@SCREENFIELDVALUE

@SCREENFIELDNAME

@SCREENNAME

@SCREENSETNAME

@SIZE

@TRANSACTIONPROPERTYNAME

@TYPE

@UI

String Functions for Rules

@CONCATENATE

@FIND

@LEFT

@LENGTH

@LOWERCASE

@MID

@NEWLINE

@REMOVE

@REPLACE

@RFIND

@RIGHT

@TAB

@TRIM

@UPPERCASE

System Functions for Rules

@DATE

@DATE_AND_TIME

@DISTANCE_MILES

@DISTANCE_KILOMETERS

@GPS_LOCATION

@IS_VALID_LOCATION

@JAVASCRIPT

@LATITUDE

@LOCATION

@LONGITUDE

@MODULE_ENABLED

@OFFLINE

@TIME

@TIME_TICKS

@USERID

Table Functions for Rules

@COMPLEXTABLE

@TABLE

@TABLE_COUNT

Agentry Data Markup Language

SDML Data Tags Overview

<<user>> Data Tag Container

<<user.client>> Data Tag Container

<<user.info>> Data Tag Container

<<server>> Data Tag Container

Data Tags for Application Globals

Query Constants Files and Data Tags

Password Data Tags

Complex Table Data Tags

Data Table Data Tags

Property Data Tags Overview

Data Tags and Property Data Types

<<agent>> Data Tag Container

SDML Function Tags Overview

<<if>>

<<case>>

<<skip>>

<<stop>>

<<abort>>

<<rollback>>

<<and>>

<<or>>

<<not>>

<<eq>>

<<ne>>

<<gt>>

<<lt>>

<<ge>>

<<le>>

<<empty>>

<<notEmpty>>

<<size>>

<<exists>>

<<foreach>>

<<upper>>

<<lower>>

<<length>>

<<join>>

<<dequote>>

<<trunc>>

<<wordTrunc>>

<<cgi>>

<<sum>>

<<diff>>

<<prod>>

<<div>>

<<remainder>>

<<local>>

<<sql>>

<<include>>

Agentry Test Script Overview

Agentry Test Script: Script Elements Overview

<script>

<script-log>

<script-pause>

Agentry Test Script: Button Elements Overview

<button-expect>

<button-push>

<button-wait>

Agentry Test Script: Field Elements Overview

<field-button-push>

<field-expect>

<field-label-select>

<field-popup>

<edit-select>

<field-set>

Agentry Test Script: List Elements Overview

<list-double-click>

<list-expect>

<list-select>

<list-sort-by>

<detail>

<header>

<columnheader>

<row>

<menu-expect>

<menu-select>

<menu>

<item>

Agentry Test Script: Tree Elements Overview

<tree-select>

<tree-expect>

<node>

<tree-expand>

<tree-collapse>

<tree-toggle>

<tree-double-click>

<tree-count-visible>

Agentry Test Script: Scanner Elements Overview

<scan-data>

<scan-enable>

<scan-start>

Agentry Test Script: SQL Elements Overview

<dsn-create-sql>

<dsn-remove-sql>

<sql-command>

<sql-connect>

<sql-expect>

<sql-row>

<sql-column>

Agentry Test Script: Tab Elements Overview

<tab-expect>

<tab-select>

Agentry Test Script: Window Elements Overview

<window-close>

<window-close-main>

<window-expect>

<window-sign>

<point>

Agentry Test Script: Client Elements Overview

<client-restart>

<registry>

<key>

<value>

Agentry Test Script: Client Host Elements overview

<command-line>

<key-press>

Agentry Java API

com.syclo.agentry package

utility package

DataTableMapIterator< K, V > class

DataTableMapIterator(Map< K, V >) method

hasNext() method

next() method

remove() method

AgentryException class

AgentryException constructor

AgentryException(String) constructor

AgentryException(String, String, String) constructor

AgentryException(String, String, String, Throwable) constructor

AgentryException(String, Throwable) constructor

getNotificationText() method

getNotificationTitle() method

getOkButtonLabel() method

BusinessLogicException class

BusinessLogicException constructor

BusinessLogicException(String) constructor

BusinessLogicException(String, Throwable) constructor

ComplexTableSession class

ComplexTableSession(String, Server, SessionData, User) constructor

ComplexTable< CTOBJ > class

build() method

ComplexTable(ComplexTableSession, GregorianCalendar) method

dataIterator() method

deleteIterator() method

getClientLastDataUpdateTime() method

getNewDataUpdateTime() method

getSession() method

initialize() method [deprecated]

isRebuilding() method

reload() method [deprecated]

setNewDataUpdateTime(GregorianCalendar) method

willRebuildTable() method

DataTableObject class

DataTableObject(String, String) constructor

code() method [deprecated]

equals(Object) method

getKey() method

getValue() method

hashCode() method

value() method [deprecated]

DataTableSession class

DataTableSession(String, Server, SessionData, User) constructor

DataTable< DTOBJ extends DataTableObject > class

DataTable(DataTableSession, GregorianCalendar) method

getClientLastDataUpdateTime() method

getSession() method

initialize() method

isOutOfDate() method

iterator() method

FatalTransactionException class

FatalTransactionException constructor

FatalTransactionException(String) constructor

FatalTransactionException(String, String, String) constructor

FatalTransactionException(String, String, String, Throwable) constructor

FatalTransactionException(String, Throwable) constructor

FatalTransactionExceptionStop class

FatalTransactionExceptionStop constructor

FatalTransactionExceptionStop(String, String, String) constructor

FatalTransactionExceptionStop(String, String, String, Throwable) constructor

FetchSession class

FetchSession(String, Server, SessionData, User) constructor

beginClientExchange() method

beginFetchObjectRead() method

beginFetchRemoval() method

beginServerExchange() method

endClientExchange() method

endFetchObjectRead() method

endFetchRemoval() method

endServerExchange() method

LoginBlockedException class

LoginBlockedException constructor

LoginBlockedException() constructor

LoginBlockedException(String) constructor

LoginBlockedException(String, Throwable) constructor

LoginException class

LoginException constructor

LoginException() constructor

LoginException(String) constructor

LoginException(String, Throwable) constructor

LoginSkippedException class

LoginSkippedException constructor

LoginSkippedException() constructor

LoginSkippedException(String) constructor

LoginSkippedException(String, Throwable) constructor

PasswordExpiredCannotChangeException class

PasswordExpiredCannotChangeException constructor

PasswordExpiredCannotChangeException() constructor

PasswordExpiredCannotChangeException(String) constructor

PasswordExpiredCannotChangeException(String, Throwable) constructor

PasswordExpiredException class

PasswordExpiredException constructor

PasswordExpiredException() constructor

PasswordExpiredException(String) constructor

PasswordExpiredException(String, Throwable) constructor

PasswordInvalidException class

PasswordInvalidException constructor

PasswordInvalidException() constructor

PasswordInvalidException(String) constructor

PasswordInvalidException(String, Throwable) constructor

PasswordWarningCannotChangeException class

PasswordWarningCannotChangeException constructor

PasswordWarningCannotChangeException() constructor

PasswordWarningCannotChangeException(String) constructor

PasswordWarningCannotChangeException(String, Throwable) constructor

PasswordWarningException class

PasswordWarningException constructor

PasswordWarningException() constructor

PasswordWarningException(String) constructor

PasswordWarningException(String, Throwable) constructor

PushSession class

PushSession(String, Server, SessionData) constructor

beginPushError() method [deprecated]

beginPushReadStep() method

beginPushRemoval() method

beginPushResponse() method [deprecated]

beginPushRetrieval() method

endPushError() method [deprecated]

endPushReadStep() method

endPushRemoval() method

endPushResponse() method [deprecated]

endPushRetrieval() method

PushUserSession class

PushUserSession(String, Server, SessionData, User) constructor

beginDisablePush() method

beginEnablePush() method

beginPushError() method

beginPushResponse() method

disablePush() method

enablePush() method

endDisablePush() method

endEnablePush() method

endPushError() method

endPushResponse() method

RetryTransactionException class

RetryTransactionException constructor

RetryTransactionException(String, String, String) constructor

RetryTransactionException(String, String, String, Throwable) constructor

RetryTransactionWithChangeException class

RetryTransactionWithChangeException constructor

RetryTransactionWithChangeException(String, String, String) constructor

RetryTransactionWithChangeException(String, String, String, Throwable) constructor

Server class

Server.LoginEnumeration enum

throwException() method

Server.LoginFailureReason enum

Server() constructor

createComplexTableSession(String, SessionData, User) method

createDataTableSession(String, SessionData, User) method

createFetchSession method

createFetchSession(String, Server, SessionData, User) method [deprecated]

createFetchSession(String, SessionData, User) method

createPushSession method

createPushSession(String, Server, SessionData) method [deprecated]

createPushSession(String, SessionData) method

createPushUserSession method

createPushUserSession(String, Server, SessionData, User) method [deprecated]

createPushUserSession(String, SessionData, User) method

createServiceEventSession method

createServiceEventSession(String, Server, SessionData) method [deprecated]

createServiceEventSession(String, SessionData) method

createTransactionSession method

createTransactionSession(String, Server, SessionData, User) method [deprecated]

createTransactionSession(String, SessionData, User) method

createUser method

createUser(String) method

createUser(String, int) method [deprecated]

debug(String) method

decryptPassword(String) method

findConfigurationFile(String) method

getImplementationVersion() method

getInstance() method

getSpecificationVersion() method

getTimeZone() method

login method

login(String, String, SessionData) method [deprecated]

login(User, String, SessionData) method

loginBlocked method

loginBlocked(String, StringBuffer) method [deprecated]

loginBlocked(User, String, StringBuffer, SessionData) method

loginBlocked(User, StringBuffer, SessionData) method [deprecated]

loginFailed method

loginFailed(String, StringBuffer) method [deprecated]

loginFailed(User, String, LoginFailureReason, StringBuffer, SessionData) method

loginPreviousUser method

loginPreviousUser(String, String, SessionData) method [deprecated]

loginPreviousUser(User, String, SessionData) method

shutdown() method

startup() method

ServiceEvent class

ServiceEvent(Server, SessionData, CallbackInterface) constructor

dataReceived(Object) method

ServiceEventSession class

ServiceEventSession(String, Server, SessionData) constructor

beginDataAndUpdateSteps() method

beginReadSteps() method

beginServiceEventError() method

endDataAndUpdateSteps() method

endReadSteps() method

endServiceEventError() method

Session class

Session constructor

Session(String, Server, SessionData) constructor

Session(String, Server, SessionData, User) constructor

debug(String) method

getEncodedPassport() method

getName() method

getServer() method

getSessionData() method

getUser() method

sessionAborted() method

Steplet class

Steplet constructor

Steplet(FetchSession) constructor

Steplet(PushSession) constructor

Steplet(PushUserSession) constructor

Steplet(ServiceEventSession) constructor

Steplet(TransactionSession) constructor

doSteplet() method

getNotificationText() method

getNotificationTitle() method

getOkButtonLabel() method

getReturnData() method

getSession() method

notificationText() method [deprecated]

notificationTitle() method [deprecated]

okButtonLabel() method [deprecated]

StepletAbortException class

StepletAbortException(String) constructor

StepletStopException class

StepletStopException(String) constructor

SycloCalendar class

SycloCalendar constructor

SycloCalendar() constructor

SycloCalendar(GregorianCalendar) constructor

SycloCalendar(GregorianCalendar, Locale) constructor

SycloCalendar(Locale) constructor

SycloCalendar(TimeZone) constructor

SycloCalendar(TimeZone, Locale) constructor

SycloCalendar(int, int, int) constructor

SycloCalendar(int, int, int, int, int) constructor

SycloCalendar(int, int, int, int, int, int) constructor

getInvalidTimeAndDate() method

isInvalidTimeAndDate method

isInvalidTimeAndDate() method

isInvalidTimeAndDate(GregorianCalendar) method

TransactionSession class

TransactionSession(String, Server, SessionData, User) constructor

beginTransaction() method

endTransaction() method

User class

User.ChangePasswordResult enum

getValue() method

User(String) constructor

backendTimeAndDate() method [deprecated]

beginChangePassword() method

changePassword(String, String) method

changePasswordFailed(StringBuffer) method

changePasswordSessionAborted() method

debug(String) method

endChangePassword() method

getKerberosServiceTicket(String, String) method

getName() method

getSystemConnectionTime() method

getTimeZone(StringBuffer) method [deprecated]

getUserSubject() method

loggedIn() method

loggedOut() method

reLoggedIn() method

revalidate(String) method

timedOut() method

update(GregorianCalendar) method

SessionData interface

sessionData(String) constructor

eval(String) method

getBoolean(String) method

getBytes(String) method

getDouble(String) method

getEncodedPassport() method

getFloat(String) method

getInteger(String) method

getLong(String) method

getString(String) method

getTimeAndDate method

getTimeAndDate(String) method

getTimeAndDate(String, String) method

Agentry Device Client Branding SDK

Agentry Client Installer and Executable Branding

Agentry Windows and Windows Mobile Clients Branding Overview

Branding Agentry Installers

Agentry ActiveX SDK

Technical Overview - ActiveX Controls and the Agentry Client

External Field - ActiveX Control

Action Step Type: External Field Command

ActiveX Control - Features Log

Agentry Client ActiveX API Methods

ActiveXControlValueChanged

ActiveXControlValueEntered

ExecuteAgentryAction

GetPropertyFromMappings

GetPropertyFromObject

GetPropertyType

PropertyAsString

NextCollectionProperty

CollectionHasNextProperty

RewindCollection

GetAgentryString

Enumerated List: AgentryActiveXPropertyType

Expected Methods Implemented in ActiveX Control

ActiveX Expected Method Declarations - eMbedded Visual C++

ActiveX Expected Method Declarations - MS Visual Basic

AgentryInitialize

AgentrySetActiveXControlHost

AgentryDestroy

AgentryGetValue

AgentrySetFocus

AgentryGetSpecificValue

AgentryUpdateScanData

AgentryEnable

AgentryShow

AgentryUpdateRuleEvaluated

AgentryGetScriptValue

AgentrySetScriptValue

Agentry Client API for External Processes Technical Overview

AgentryInitialize

AgentryUnInitialize

EvaluateAgentryRule

ExecuteAgentryAction

ExecuteAgentryTransaction

Data Types Defined in the Agentry Client API for External Processes

Agentry OpenUI API

OpenUI SDK Concepts, Usage and Guidance

Agentry OpenUI API for Android

com.sap.mobile.platform package

client package

openui package

adapters package

ButtonDisplayAdapter class

buttonImageChanged(AgentryImage) method

initialize(ButtonDisplayModel, Context) method

selectedStateChanged(boolean) method

CollectionDisplayAdapter class

allItemsChanged() method

initialize(CollectionDisplayModel, Context) method

itemAdded(int) method

itemChanged(int) method

itemRemoved(int) method

itemSelected(int) method

DateAndTimeDisplayAdapter class

initialize(DateAndTimeDisplayModel, Context) method

valueChanged(GregorianCalendar) method

DateAndTimeEditAdapter class

initialize(DateAndTimeEditModel, Context) method

valueChanged(GregorianCalendar) method

DateDisplayAdapter class

initialize(DateDisplayModel, Context) method

valueChanged(GregorianCalendar) method

DateEditAdapter class

initialize(DateEditModel, Context) method

valueChanged(GregorianCalendar) method

DecimalDisplayAdapter class

initialize(DecimalDisplayModel, Context) method

valueChanged(double) method

DecimalEditAdapter class

initialize(DecimalEditModel, Context) method

valueChanged(double) method

DurationDisplayAdapter class

fractionalHourValueChanged(double) method

initialize(DurationDisplayModel, Context) method

valueChanged(int) method

DurationEditAdapter class

fractionalHourValueChanged(double) method

initialize(DurationEditModel, Context) method

valueChanged(int) method

EmbeddedImageDisplayAdapter class

imageChanged() method

imageSelectionChanged() method

initialize(EmbeddedImageDisplayModel, Context) method

ExternalDataDisplayAdapter class

initialize(ExternalDataDisplayModel, Context) method

valueChanged(String) method

ExternalDataEditAdapter class

initialize(ExternalDataEditModel, Context) method

valueChanged(String) method

FieldAdapter class

FieldAdapter.TouchQueryHandler interface

isOnBottomEdge() method

isOnTopEdge() method

getAutosizeBehavior() method

getContentHeightForAutosizing(int) method

getExtensionString(String) method

getView() method

isAgentryDisplayingLabel() method

isAgentryDisplayingValidationFailure() method

onActivityEnding() method

onActivityResult(int, int, Intent) method

onPause() method

onResume() method

setEnabled(boolean) method

setHyperlinkEnabled(boolean) method

setValid(boolean, String) method

setVisible(boolean) method

updateLabel(String) method

IntegerDisplayAdapter class

initialize(IntegerDisplayModel, Context) method

valueChanged(int) method

IntegerEditAdapter class

initialize(IntegerEditModel, Context) method

valueChanged(int) method

LabelDisplayAdapter class

initialize(LabelDisplayModel, Context) method

valueChanged(String) method

LocationDisplayAdapter class

initialize(LocationDisplayModel, Context) method

valueChanged(AgentryLocation) method

LocationEditAdapter class

initialize(LocationEditModel, Context) method

valueChanged(AgentryLocation) method

StringDisplayAdapter class

initialize(StringDisplayModel, Context) method

valueChanged(String) method

StringEditAdapter class

initialize(StringEditModel, Context) method

valueChanged(String) method

TimeDisplayAdapter class

initialize(TimeDisplayModel, Context) method

valueChanged(GregorianCalendar) method

TimeEditAdapter class

initialize(TimeEditModel, Context) method

valueChanged(GregorianCalendar) method

models package

ButtonDisplayModel interface

getButtonImage() method

getButtonText() method

getButtonType() method

hasAction() method

isButtonSelected() method

processInput() method

CollectionDisplayModel interface

getCollection() method

getDisplayedItemAt(int) method

getDisplayRowCount() method

getSelectedRow() method

selectRow(int) method

DateAndTimeDisplayModel interface

getValue() method

DateAndTimeEditModel interface

processInput(GregorianCalendar) method

DateDisplayModel interface

getValue() method

DateEditModel interface

processInput(GregorianCalendar) method

DecimalDisplayModel interface

getValue() method

DecimalEditModel interface

getMaximumValue() method

getMinimumValue() method

processInput(double) method

DurationDisplayModel interface

getDurationDisplayFormat() method

getFractionalHourValue() method

getValue() method

DurationEditModel interface

getMaximumFractionalHour() method

getMaximumValue() method

getMinimumFractionalHour() method

getMinimumValue() method

processDecimalInput(double) method

processInput(int) method

EmbeddedImageDisplayModel interface

getColumnCount() method

getHighlightColor() method

getImage() method

getImagePosition() method

getImagePresentation() method

getRowCount() method

isImageCellSelected(long, long) method

setImageCellSelected(long, long) method

ExternalDataDisplayModel interface

getFilePath() method

ExternalDataEditModel interface

processInput(String) method

FieldModel interface

executeAgentryAction(String) method

executeHyperlinkAction() method

getAgentryActionEnableState(String) method

getAgentryString(String) method

getLabel() method

isAutosizeSupported() method

isEnabled() method

isHidden() method

isHyperlinkEnabled() method

launchActivity(Intent, int) method

requestLayoutHeight(int) method

IntegerDisplayModel interface

getValue() method

IntegerEditModel interface

getMaximumValue() method

getMinimumValue() method

processIntegerInput(int) method

LabelDisplayModel interface

getValue() method

LocationDisplayModel interface

getValue() method

LocationEditModel interface

processInput(AgentryLocation) method

StringDisplayModel interface

getValue() method

isCarriageReturnAllowed() method

isWordWrapAllowed() method

StringEditModel interface

getMaximumLength() method

getMinimumLength() method

isPasswordInput() method

processInput(String) method

TimeDisplayModel interface

getValue() method

TimeEditModel interface

processInput(GregorianCalendar) method

security package

CredentialManagerActivity class

getModel() method

onCreate(Bundle) method

CredentialManagerAdapter class

getClientCertificate() method

getClientCertificatePassword() method

initialize(Context) method

requiresActivity(LastClientAuthenticationResult) method

CredentialManagerModel interface

complete() method

getLastClientAuthenticationResult() method

registerActivity(CredentialManagerActivity) method

setClientCertificate(byte[]) method

setClientCertificatePassword(String) method

core package

dataapi package

AgentryData interface

AgentryData.DataType enum

getValue() method

COLLECTION variable

OBJECT variable

PROPERTY variable

UNKNOWN variable

dispose() method

getAncestor() method

getDataType() method

getDescendant(int) method

getDescendantCount() method

getDisplayName() method

getName() method

getProperties() method

getRoot() method

isValid() method

AgentryProperty interface

AgentryProperty.PropertyType enum

getValue() method

BOOLEAN variable

COMPLEX_TABLE_SELECTION variable

DATA_TABLE_SELECTION variable

DATE variable

DATE_AND_TIME variable

DECIMAL_NUMBER variable

DURATION variable

EXTERNAL_DATA variable

IDENTIFIER variable

IMAGE variable

INTEGER_NUMBER variable

LIST_SELECTION variable

LOCATION variable

SIGNATURE variable

STRING variable

TIME variable

UNKNOWN variable

asBoolean() method

asDate() method

asDateAndTime() method

asDouble() method

asLocation() method

asLong() method

asString() method

asTime() method

getPropertyType() method

openui package

AgentryImage class

AgentryImage.ImageType enum

getValue() method

ImageType_Bitmap variable

ImageType_GIF variable

ImageType_JPEG variable

ImageType_PNG variable

ImageType_Unknown variable

AgentryImage(String, ImageType, ImagePresentation, ImagePosition, int, int, int) constructor

getBitmapData() method

getImageName() method

getImagePosition() method

getImagePresentation() method

getImageType() method

getMaskColor() method

isValid() method

needsBitmapData() method

setBitmapData(byte[]) method

AgentryLocation class

AgentryLocation(boolean, double, double, int, double) constructor

getDilution() method

getLatitude() method

getLongitude() method

getSatellites() method

isValid() method

setDilution(double) method

setLatitude(double) method

setLongitude(double) method

setSatellites(int) method

setValid(boolean) method

MaskColor class

MaskColor(int, int, int) constructor

MaskColor(short, short, short) constructor

getBlue() method

getGreen() method

getRed() method

isValid() method

ProcessInputReturn class

ProcessInputReturn(boolean, boolean, boolean) constructor

getChanged() method

getMunged() method

getValid() method

ActionEnableType enum

ActionDisable variable

ActionEnable variable

ActionError variable

ActionNoOperation variable

ActionResult enum

Action_BackUp variable

Action_Cancel variable

Action_Complete variable

Action_Error variable

Action_Pending variable

AutosizeBehavior enum

Autosize_FillVisible variable

Autosize_None variable

Autosize_WrapContent variable

ButtonType enum

ButtonStyleCheckbox variable

ButtonStylePush variable

ButtonStyleRadio variable

DurationDisplayFormat enum

DecHour variable

HourMin variable

HourMinSec variable

MinSec variable

ImagePosition enum

getValue() method

ImagePosition_Center variable

ImagePosition_LowerLeft variable

ImagePosition_LowerMiddle variable

ImagePosition_LowerRight variable

ImagePosition_MiddleLeft variable

ImagePosition_MiddleRight variable

ImagePosition_Unknown variable

ImagePosition_UpperLeft variable

ImagePosition_UpperMiddle variable

ImagePosition_UpperRight variable

ImagePresentation enum

getValue() method

ImagePresentation_CropToFit variable

ImagePresentation_FullSize variable

ImagePresentation_LockAspectRatio variable

ImagePresentation_StretchToFit variable

ImagePresentation_Unknown variable

LastClientAuthenticationResult enum

No_Prior_Attempt variable

Prior_Attempt_Failed_SSL variable

Prior_Attempt_Successful variable

OpenUIImage interface

getBitmapData() method

getImageName() method

getImageType() method

getMaskColor() method

isValid() method

Agentry OpenUI API for iOS

OpenUI for iOS

OpenUI Overview (iOS)

OpenUI Installation Instructions (iOS)

OpenUI Getting Started (iOS)

OpenUI SMPOpenUICredentialProvider (iOS)

OpenUI Known Issues (iOS)

iOSOpenUIExternal

SMPOpenUIImage class

image property

name property

position property

presentation property

SMPOpenUILocation class

initWithCLLocation: method

initWithLatitude:andLongitude:andSatellites:andDilution: method

locationWithCLLocation: method

locationWithLatitude:andLongitude:andSatellites:andDilution: method

dilution property

latitude property

location property

longitude property

satellites property

valid property

SMPOpenUIButtonDisplayAdapter protocol

initWithButtonDisplayModel: method

model:didChangeButtonImage: method

model:didChangeSelected: method

SMPOpenUIButtonDisplayModel protocol

processInput method

buttonImage property

buttonText property

buttonType property

selected property

supportsAction property

value property

SMPOpenUICollectionDisplayAdapter protocol

allObjectsChanged: method

initWithCollectionDisplayModel: method

model:didSelectObjectAtIndex: method

model:objectAddedAtIndex: method

model:objectChangedAtIndex: method

model:objectDeletedAtIndex: method

SMPOpenUICollectionDisplayModel protocol

collection method

displayedObjectAtIndex: method

processInputSelection: method

displayedObjectCount property

selection property

SMPOpenUICredentialProviderAdapter protocol

getCertificateForModel: method

getPasswordForModel: method

getViewControllerForModel: method

initWithIphoneCredentialModel: method

shouldDisplayUIForModel: method

SMPOpenUICredentialProviderModel protocol

complete method

getLastClientAuthenticationResult method

setClientCertificate: method

setClientCertificatePassword: method

LastClientAuthenticationResult enumeration

SMPOpenUIDateAndTimeDisplayAdapter protocol

initWithDateAndTimeDisplayModel: method

model:didChangeDateAndTime: method

SMPOpenUIDateAndTimeDisplayModel protocol

value property

SMPOpenUIDateAndTimeEditAdapter protocol

initWithDateAndTimeEditModel: method

model:didChangeDateAndTime: method

SMPOpenUIDateAndTimeEditModel protocol

processInputDateAndTime: method

SMPOpenUIDateDisplayAdapter protocol

initWithDateDisplayModel: method

model:didChangeDate: method

SMPOpenUIDateDisplayModel protocol

value property

SMPOpenUIDateEditAdapter protocol

initWithDateEditModel: method

model:didChangeDate: method

SMPOpenUIDateEditModel protocol

processInputDate: method

SMPOpenUIDecimalDisplayAdapter protocol

initWithDecimalDisplayModel: method

model:didChangeDecimal: method

SMPOpenUIDecimalDisplayModel protocol

value property

SMPOpenUIDecimalEditAdapter protocol

initWithDecimalEditModel: method

model:didChangeDecimal: method

SMPOpenUIDecimalEditModel protocol

processInputDecimal: method

maximumValue property

minimumValue property

SMPOpenUIDurationDisplayAdapter protocol

initWithDurationDisplayModel: method

model:didChangeDuration: method

model:didChangeFractionalHour: method

SMPOpenUIDurationDisplayModel protocol

displayFormat property

fractionalHourValue property

value property

SMPOpenUIDurationEditAdapter protocol

initWithDurationEditModel: method

model:didChangeDuration: method

model:didChangeFractionalHour: method

SMPOpenUIDurationEditModel protocol

processInputDuration: method

processInputFractionalHour: method

maximumFractionalHourValue property

maximumValue property

minimumFractionalHourValue property

minimumValue property

SMPOpenUIEmbeddedImageDisplayAdapter protocol

initWithEmbeddedImageModel: method

model:didChangeImage: method

modelDidChangeImageCellSelection: method

SMPOpenUIEmbeddedImageDisplayModel protocol

imageCellClickedAtRow:andColumn: method

isImageCellSelectedAtRow:andColumn: method

columns property

highlightSelectedColor property

image property

rows property

SMPOpenUIExternalDataDisplayAdapter protocol

initWithExternalDataDisplayModel: method

model:didChangeExternalData: method

SMPOpenUIExternalDataDisplayModel protocol

value property

SMPOpenUIExternalDataEditAdapter protocol

initWithExternalDataEditModel: method

model:didChangeExternalData: method

SMPOpenUIExternalDataEditModel protocol

processInputExternalData: method

SMPOpenUIFieldAdapter protocol

agentryShouldDisplayLabel method

agentryShouldDisplayValidationFailure method

autosizeBehavior method

model:didSetEnabled: method

model:didSetHyperlinkEnabled: method

model:didSetValid:withValidationFailureText: method

model:didSetVisible: method

model:didUpdateLabel: method

model:wantsExtensionString: method

model:wantsViewHeightForWidth: method

viewForFrame: method

SMPOpenUIFieldModel protocol

agentryActionEnableState: method

agentryString: method

executeAgentryAction: method

executeHyperlinkAction method

requestLayoutHeigh: method

autosizing property

enabled property

hidden property

hyperlinkEnabled property

label property

SMPOpenUIIntegerDisplayAdapter protocol

initWithIntegerDisplayModel: method

model:didChangeInteger: method

SMPOpenUIIntegerDisplayModel protocol

value property

SMPOpenUIIntegerEditAdapter protocol

initWithIntegerEditModel: method

model:didChangeInteger: method

SMPOpenUIIntegerEditModel protocol

processInputInteger: method

maximumValue property

minimumValue property

SMPOpenUILabelDisplayAdapter protocol

initWithLabelDisplayModel: method

model:didChangeLabel: method

SMPOpenUILabelDisplayModel protocol

value property

SMPOpenUILocationDisplayAdapter protocol

initWithLocationDisplayModel: method

model:didChangeLocation: method

SMPOpenUILocationDisplayModel protocol

value property

SMPOpenUILocationEditAdapter protocol

initWithLocationEditModel: method

model:didChangeLocation: method

SMPOpenUILocationEditModel protocol

processInputLocation: method

SMPOpenUIStringDisplayAdapter protocol

initWithStringDisplayModel: method

model:didChangeString: method

SMPOpenUIStringDisplayModel protocol

allowsCarriageReturn property

usesWordWrap property

value property

SMPOpenUIStringEditAdapter protocol

initWithStringEditModel: method

model:didChangeString: method

SMPOpenUIStringEditModel protocol

processInputString: method

isPasswordInput property

maximumLength property

minimumLength property

SMPOpenUITimeDisplayAdapter protocol

initWithTimeDisplayModel: method

model:didChangeTime: method

SMPOpenUITimeDisplayModel protocol

value property

SMPOpenUITimeEditAdapter protocol

initWithTimeEditModel: method

model:didChangeTime: method

SMPOpenUITimeEditModel protocol

processInputTime: method

SMPOpenUIUnsignedIntegerDisplayAdapter protocol

initWithUnsignedIntegerDisplayModel: method

model:didChangeUnsignedInteger: method

SMPOpenUIUnsignedIntegerDisplayModel protocol

value property

SMPOpenUIUnsignedIntegerEditAdapter protocol

initWithUnsignedIntegerEditModel: method

model:didChangeUnsignedInteger: method

SMPOpenUIUnsignedIntegerEditModel protocol

processInputUnsignedInteger: method

maximumValue property

minimumValue property

SMPOpenUIButtonType enumeration

SMPOpenUIAutosizeBehavior enumeration

SMPOpenUIImagePresentation enumeration

SMPOpenUIDurationDisplayFormat enumeration

SMPOpenUIActionEnableType enumeration

SMPOpenUIActionResult enumeration

SMPOpenUIProcessInputReturn enumeration

SMPOpenUIImagePosition enumeration

Agentry OpenUI API for WPF

AlternateInputEventArgs class

AlternateInputEventArgs(string) constructor

AlternateInputText property

IAgentryCollection interface

IAgentryControlViewModel interface

DoesAgentryActionExist(string) method

ExecuteAgentryAction(string) method

ExecuteHyperlinkAction() method

GetAgentryString(string) method

IsAgentryActionEnabled(string) method

OnPropertyChanged(string) method

IsAutoSize property

IsEnabled property

IsHyperlinkEnabled property

IsVisible property

Label property

IAgentryControlViewModelCollectionDisplay interface

DisplayedItemAt(int) method

SelectItem(int) method

DisplayedItemCount property

SelectedItem property

IAgentryControlViewModelDateTime interface

ProcessInput(DateTime) method

IAgentryControlViewModelDateTimeDisplay interface

DateValue property

TimeValue property

Value property

IAgentryControlViewModelDecimal interface

ProcessInput(double) method

IAgentryControlViewModelDecimalDisplay interface

StringValue property

IAgentryControlViewModelDuration interface

ProcessInput(TimeSpan) method

MaximumValue property

MinimumValue property

IAgentryControlViewModelDurationDisplay interface

DurationFormat property

DurationValue property

IAgentryControlViewModelFile interface

ProcessInput(string) method

IAgentryControlViewModelFileDisplay interface

FilePath property

IAgentryControlViewModelImage interface

IsSelected(int, int) method

SelectCell(int, int) method

Columns property

Image property

Rows property

SelectColor property

IAgentryControlViewModelLabel interface

IAgentryControlViewModelNumber< T > interface

ProcessInput(T) method

Maximum property

Minimum property

IAgentryControlViewModelNumberDisplay< T > interface

NumberValue property

IAgentryControlViewModelStringDisplay interface

StringValue property

WordWrap property

IAgentryControlViewModelStringEdit interface

ProcessInput(string) method

AcceptReturn property

IsPassword property

MaximumLength property

MinimumLength property

IAgentryData interface

Collections() method

Descendant(int) method

Objects() method

Properties() method

Ancestor property

DataType property

DescendantCount property

DisplayName property

InternalName property

Root property

IAgentryObject interface

IAgentryProperty interface

ToBoolean() method

ToDate() method

ToDateTime() method

ToDouble() method

ToInt() method

ToString() method

ToTime() method

ToUInt() method

PropertyType property

IAlternateInputDevice interface

InitiateScan() method

IsPresent property

AlternateInputReceived event

ICredentials interface

GetClientCertificateData(AuthenticationResults, out byte[], out string) method

ICustomAgentryControl interface

GetExtensionString(string) method

ClientDisplaysLabel property

ClientDisplaysValidationError property

AgentryDataType enumeration

AgentryPropertyType enumeration

AuthenticationResults enumeration

SMPActionResult enumeration

SMPActionState enumeration

SMPDurationFormat enumeration

SMPProcessInputReturn enumeration

SMS Application Development

Developing SMS Applications

Setting Up the Development Environment

Configuring the HTTP Port

Developing Applications

Messaging Server

Application States

Base States

Subscriber States

USSD States

Custom States

Input and Output Parameters

State Machine

Application Composer

State Transitions

Controlling State Transitions with Regular Expressions

Testing Regular Expressions

State Editor

Adding States to Applications

Editing State Properties

Removing States

Removing State Transitions

Developing Interactive Applications

Adding Keywords to Applications

Searching for a Keyword

Designing Application Task Flows

Short Codes, Long Codes, and Keywords

Developing Event Applications

Events

Creating Events

Creating One-Time Event Windows

Creating Recurring Event Windows

Assigning Events to Applications

Activation

Application Mode Transitions

Activating Applications

Activating Events

Deactivating Applications

Deactivating Events

Testing Applications

Testing Interactive Applications

Sample Interactive Message Log

Testing Event Applications

Sample Event Message Log

Importing Applications

Importing Application XML Files

Creating Applications from Templates

Exporting Applications

Exporting a Single Application

Exporting a Group of Applications

Sample Applications

Cash-Out Interactive Application

Cash-Out Application State Editor

Mobiliser Counter Interactive Application

Utility Notification Event Application

Developing Custom Application States

Application Life Cycle

Developing and Deploying Custom States

Extending the SmappStatePlugin Class

StatePlugin Interface

PluginInterface Interface

Extending the AbstractDynamicMenu Class

AbstractDynamicMenu Life Cycle

Implementing State Logic

SmappStateProcessingContext

SmappStateProcessingAction

Custom State Information

Custom State Variables

Variables for Troubleshooting

Defining Input Variables

Defining Output Variables

Accessing Input Variables

List Variables

State Attributes Class Hierarchy

Setting Up Apache Maven

Installing Apache Maven

Configuring Apache Maven

Deploying State SDK Bundles to a Maven Repository

Custom State Bundles

Building Custom State Bundles

Creating Maven Projects

Maven Project Structure

Customizing Maven POM Files

Sample Maven POM File

Creating Maven Project Artifacts

Building Maven Projects

Declaring States as Spring Beans

Configuring Bean Properties

Registering States as OSGi Services

Deploying State Bundles

Verifying Deployment Using Telnet

Verifying Deployment Using the AIMS Web Console

Enabling the AIMS System Web Console

Configuring State Bundles

Verifying Bundle Configuration Using Telnet

Verifying Bundle Configuration Using the AIMS Web Console

Custom State Bundle Samples

Consuming SOAP Web Service Sample

Consuming RESTful Services

Developing Quick-Start Templates

Creating Dynamic Template Plug-Ins

Custom State Samples

Sample GetMyWeather State

Sample Custom State

Sample Custom-Menu State

State SDK Core Components

States Catalog

Add Subscriber State

Application Call State

Application Call Return State

Compare Typed Variables State

Compare Variables State

Copy Variables State

Counter State

Get Subscriber State

Goto Application State

Process Subscriber State

Send SMS State

Send USSD Input State

Send USSD Menu State

Sample USSD Menu Code

Send USSD Text State

Set Variable State

Start Application State

Update Subscriber State

SMS Application API Reference

com.sybase365.mobiliser.brand package

plugins package

api package

smapp package

controls package

IAttribute interface

getDescription() method

getId() method

getText() method

setContext(SmappStateProcessingContext) method

setDescription(String) method

setId(String) method

dao package

StateDaoImpl class

StateDaoImpl(final SmappStateDao, final MwizMessageContext) constructor

bulkSaveSessionAttributes(Map< String, String >) method

deleteSessionAttribute(String) method

getLanguage(Long) method

getOrCreateCustomerForMsisdn(String, Client) method

getSessionAttributeForKey(String) method

getSessionAttributes() method

getSessionAttributesMap() method

saveSessionAttribute(String, String) method

saveSessionAttribute(String, String, boolean) method

saveSessionAttributes(Map< String, String >) method

saveSmappTransitionLogEntry(SmappTransitionLog) method

SubscriberDaoImpl class

SubscriberDaoImpl(final SubscriberMasterDao, final Client) constructor

addSubscriberToListReturnCount(Long, SubscriberMaster) method

getSubscriber(Long, String) method

getSubscriberLists() method

saveSubscriber(SubscriberMaster) method

SmappStateProcessingAction class

SmappStateProcessingAction(SmappState) constructor

continueProcessing(SmappState) method

getContinueState() method

isContinueProcessing() method

isTerminateProcessing() method

isWaitProcessing() method

terminateProcessing() method

waitForMessage() method

SmappStateProcessingContext class

SmappStateProcessingContext(final SmappState, final MwizMessageContext, final boolean, final OutgoingQueue, final Language, final Language, final SmappStateDao, final SubscriberMasterDao, final CacheManagerDao) constructor

getLangRequest() method

getSession() method

getStateDao() method

getSubscriberDao() method

isAckMessageRequested() method

isCurrentStateEncrypted() method

setAckMessageRequest(boolean) method

setLangRequest(Language) method

updateSession() method

cacheMgr variable

client variable

clientMsisdn variable

currentState variable

customer variable

langDefault variable

matchingPattern variable

mr variable

msg variable

newSession variable

outgoingQueue variable

SmsTextI18n class

SmsTextI18n(String, Language) constructor

getLanguage() method

getText() method

SmappStateEditorContext interface

getClient() method

SmappTemplate interface

getDescription() method

getInputStream() method

getName() method

getResource() method

getVersion() method

setDescription(String) method

setName(String) method

setResource(String) method

setVersion(String) method

StatePlugin interface

getInputAttributes() method

getOutputAttributes() method

getStateId() method

getStateName() method

getStateNotes() method

isSelectable() method

loadStateAttributes(SmappStateEditorContext) method

processMessage(SmappStateProcessingContext) method

processState(SmappStateProcessingContext, SmappStateProcessingAction) method

supportEncryption() method

supportsDynTransition() method

supportsFailTransition() method

supportsGoToApplication() method

supportsOkTransition() method

supportsSendSmsMessage() method

PluginInterface interface

getInstanceName() method

getRevisionString() method

setInstanceName(String) method

shutdown() method

startup(HashMap< String, String >) method

base package

Plugin class

getInstanceName() method

setInstanceName(String) method

instanceName variable

exceptions package

InputValueFormatException class

InputValueFormatException(String) constructor

InputValueFormatException(String, Throwable) constructor

InputValueFormatException(Throwable) constructor

smapp package

beans package

GenericBean class

compareTo(GenericBean) method

convert(String) method

convert(GenericBean) method

equals(Object) method

getAttrib0() method

getAttrib1() method

getAttrib2() method

getAttrib3() method

getAttrib4() method

getAttrib5() method

getAttrib6() method

getAttrib7() method

getAttrib8() method

getAttrib9() method

getId() method

hashCode() method

parse(HashMap< String, String >) method

setAttrib0(String) method

setAttrib1(String) method

setAttrib2(String) method

setAttrib3(String) method

setAttrib4(String) method

setAttrib5(String) method

setAttrib6(String) method

setAttrib7(String) method

setAttrib8(String) method

setAttrib9(String) method

setId(String) method

GB_ATTRIB0 variable

GB_ATTRIB1 variable

GB_ATTRIB2 variable

GB_ATTRIB3 variable

GB_ATTRIB4 variable

GB_ATTRIB5 variable

GB_ATTRIB6 variable

GB_ATTRIB7 variable

GB_ATTRIB8 variable

GB_ATTRIB9 variable

GB_ID variable

BeanConverterInterface< T > interface

convert(String) method

convert(T) method

controls package

Attribute class

Attribute(String, String) constructor

getContext() method

getDescription() method

getId() method

getText() method

setContext(SmappStateProcessingContext) method

setDescription(String) method

setId(String) method

description variable

id variable

InputAttribute class

InputAttribute.InputValue class

InputValue(String) constructor

InputValue(String, String) constructor

getBoolean() method

getDouble() method

getInt() method

getLong() method

getMsisdn(String) method

getString() method

getString(int) method

toString() method

InputAttribute.InputType enum

ATTRIBUTE variable

SESSION variable

InputAttribute(String, String, boolean) constructor

getInputType() method

getInputValue() method

getInputValueWithWarning() method

getRawValue() method

getRawValueLog() method

getValue() method

isCheckboxEnabled() method

isOptional() method

isSet() method

setCheckboxEnabled(boolean) method

setInputType(InputType) method

setOptional(boolean) method

encrypted variable

OutputAttribute class

OutputAttribute(String, String) constructor

getHoldValue() method

resetHoldValue() method

setHoldValue(String) method

setHoldValue(Long) method

setHoldValue(Integer) method

setHoldValue(Boolean) method

setValue(String) method

setValue(Long) method

setValue(Integer) method

setValue(Boolean) method

SelectionBoxAttribute class

SelectionBoxAttribute(String, String, boolean) constructor

getInputValue() method

getItems() method

getItemValue(String) method

getRawValueLog() method

isSet() method

setItems(List< KeyValuePair< String, String >>) method

SessionVariableAttribute class

SessionVariableAttribute(String, String) constructor

TextBoxAttribute class

TextBoxAttribute(String, String, boolean) constructor

getInputValue() method

isSet() method

state package

AbstractDynamicMenu class

constructMenuList() method

continueWhenSingleEntry(SmappState) method

createPage(boolean) method

getLineBreak() method

getMaxMenuItems() method

getMenuListFromSession(BeanConverterInterface< T >) method

getMessageOptions(Page) method

getPaginationExit() method

getPaginationNext() method

getPaginationNextIndex() method

getStateAttributeList() method

getStateAttributes() method

getStateNotes() method

init(SmappStateProcessingAction) method

processMessageLogic(SmappStateProcessingContext) method

processStateLogic(SmappStateProcessingContext, SmappStateProcessingAction) method

saveSessionVariables(String, String) method

setMenuListToSession(List< T >) method

supportsFailTransition() method

supportsOkTransition() method

supportsSendSmsMessage() method

inShowExitMenu variable

outKey variable

outValue variable

Page class

Page(boolean) constructor

getHeader() method

getItems() method

getLineBreak() method

getPaginationExit() method

getPaginationNext() method

isExit() method

isNext() method

previewMenu() method

setExit(boolean) method

setHeader(String) method

setItems(List< KeyValuePair< String, String >>) method

setLineBreak(String) method

setNext(boolean) method

setPaginationExit(String) method

setPaginationNext(String) method

toString() method

exit variable

header variable

items variable

lineBreak variable

next variable

paginationExit variable

paginationNext variable

RequiredParameterMissingException class

RequiredParameterMissingException(String) constructor

SmappStatePlugin class

continueDyn(String) method

continueDyn(Integer) method

continueDyn(Long) method

continueFail() method

continueFail(String) method

continueOk() method

determineFollowingSmappStateFromPattern(SmappStateProcessingContext) method

determineFollowingSmappStateFromPattern(SmappStateProcessingContext, MwizMessage) method

determineFollowingSmappStateFromTransitionType(EnumSmappTransitionType, SmappState, SmappStateProcessingContext) method

getCurrentCustomer() method

getInputAttributes() method

getOutputAttributes() method

getSessionAttributeForKey(String) method

getSessionAttributes() method

getSessionId() method

getSmsText18nReplaced() method

getStateAttributes() method

getStateNotes() method

handleFatal(SmappStateProcessingContext, SmappStateProcessingAction) method

isCurrentStateEncrypted() method

isSelectable() method

loadStateAttributes(SmappStateEditorContext) method

processMessage(SmappStateProcessingContext) method

processMessageLogic(SmappStateProcessingContext) method

processState(SmappStateProcessingContext, SmappStateProcessingAction) method

processStateLogic(SmappStateProcessingContext, SmappStateProcessingAction) method

saveOutputAttributes() method

saveSessionAttribute(String, String) method

saveSessionAttribute(String, String, boolean) method

saveSessionAttributes(Map< String, String >) method

sendSmappSms(MwizMessage, Language) method

sendSmappSms(MwizMessage, Language, MwizMessageOptions) method

setAckMessage(boolean) method

shutdown() method

startup(HashMap< String, String >) method

supportEncryption() method

supportsDynTransition() method

supportsFailTransition() method

supportsGoToApplication() method

supportsOkTransition() method

supportsSendSmsMessage() method

StateUtils class

determineFollowingSmappStateFromPattern(SmappStateProcessingContext) method

determineFollowingSmappStateFromPattern(SmappStateProcessingContext, MwizMessage) method

determineFollowingSmappStateFromPaymentResult(SmappState, boolean, SmappStateProcessingContext) method

determineFollowingSmappStateFromTransitionType(EnumSmappTransitionType, SmappState, SmappStateProcessingContext) method

getSmsText18nReplaced(SmappStateProcessingContext) method

replaceTextLabelsForSessionAttributes(String, SmappStateProcessingContext) method

sendSmappSms(SmappStateProcessingContext, MwizMessage, Language, MwizMessageOptions) method

useful package

KeyValuePair< K, V > class

getKey() method

getValue() method

KeyValuePair() method

KeyValuePair(K, V) method

setKey(K) method

setValue(V) method

toString() method

PhoneNumber class

PhoneNumber(String) constructor

PhoneNumber(String, String) constructor

equals(Object) method

getInternationalFormat() method

getNationalFormat() method

getNumericInternationalFormat() method

getShortInternationalFormat() method

hashCode() method

toString() method

DEFAULT_COUNTRY_CODE variable

template package

SmappTemplateProvider class

getDescription() method

getInputStream() method

getName() method

getResource() method

getVersion() method

setDescription(String) method

setName(String) method

setResource(String) method

setVersion(String) method

LOG variable

Application Services (Mobiliser) Portal Templates

Setting Up the Development Environment

Administration Portal

Logging in to the Administration Portal

Self Care

Customer Care

Registering Customers

Find Customer

Find Pending Approval

Justify Contact

Show Contacts

System Configuration

Exchange Rate

Fees

Fee Types

Adding Fee Types

Fee Type Use Case Configuration

Adding Use Case Configuration

Fee Sets

Limits

Limit Sets

Adding Limit Sets

Adding a Use Case to an Existing Limit Set

Limit Classes

Privileges

Global Configuration

Dual Approval

Restrictions and Restriction Groups

Adding Restriction Groups

Adding Restrictions

Adding Rules

Service Packages and Terms and Conditions

Credential Policies

Adding a Customer Type Policy

Adding a Credential Policy

Adding a Credential Pattern

Interest Configuration

GL Account Tree

Bulk Processing

Customer XML File Preparation

Points of Interest CSV File Preparation

Points of Interest XML File Preparation

Coupon Admin

Coupon Types

Creating Coupon Types

Generating Coupons

Uploading Batch Coupons

Adding Coupon Locations

Assigning Coupons

Categories

Coupon Search

User Manager

Agents

Roles and Privileges

Notification Manager

Messages

Attachments

Transaction Template

Reports

Audit

Consumer Portal

Getting Started

Signing Up for a Consumer Account

Logging in to the Consumer Portal

Self Care

Friends List

Preferences

Contact Points

Mobile Alerts

Adding Mobile Alerts

Scheduling Do Not Disturb Times

Manage Accounts

Bank Accounts

Credit Cards

Stored Value Account

Offline Stored Value Accounts

External Accounts

Transactions

View Transactions

Send Money

Send Money to a Bank

Request Money

Airtime Topup

Bill Payment

Bill Configuration

Open Bills

Pay Bill

Bill History

Partner Portal

Logging in to the Partner Portal

Self Care

Customer Services

Search Customer

Cash In

Cash Out

Pickup

View Transactions

KYC Upgrade

Customer Registration

Airtime Topup

Bulk Processing

Transaction XML File Preparation

Manage Agents

Agents

Creating Agents

Creating Subagents

Adding a Balance Alert

Activate Agent

Commission Management

Reports

Portal Development and Customization

Overview

Page Layout

Unauthenticated Pages

Authenticated Pages

Application Configuration

Application Configuration Example

Application Objects

Application Customization

Services Interface – Spring Configuration

Services Interface – Client Logic Implementation

Application Top Menus

Application Left Menus

Web Pages

Style Guidelines

Page Width and Height

Page Components

Application Page Components

Content Containers

Breadcrumbs

Help Text

Error Messages and Information

Success Messages

Form Page Components

Form Input

Form Text

One- and Two-Column Forms

Form Sections

Form Buttons

Form Field Validation

Tab Index

Table Page Components

Localization Guidelines

Locale Configuration

Language Selector

Text Messages and Labels

Resource Loading

Text Messages from Java

Wicket Dynamic Validation Text

Currency Amounts

Dates and Timestamps

Lookup Lists and Codes

Troubleshooting

Quick Fixes to Simple SDK Problems

Eclipse Cannot Find jvm.dll

Entries Getting Overwritten in the OData Offline Cache

Cache Errors While Executing OData Online Requests

Agentry Editor - Publish Server Configuration Error

Issues Requiring Root Cause Analysis

Issues Requiring Product Support

Product Support Engagement Requirements

Creating an Incident on SAP Service Marketplace

Migration

Migrating Native OData Applications

Migrating iOS Native OData Applications

Migrating Android Native OData Applications

Migrating Messaging Channel OData Applications to REST SDK Applications

Migrating Mobile Business Objects

MBO and OData Architectural Differences

MBO and OData SDK Differences

Comparing MBO Models to OData Entity Data Models

Migrating SAP MBOs to OData Services

Setting Up the MBO-to-OData Development Environment

Build OData Services with NetWeaver Gateway Service Builder

Comparing the MBO Data Model with the OData Model

Creating a Project Using Service Builder

Creating the Data Model

Creating a Data Model By Importing DDIC Structures

Creating a Data Model Using an External Model File

Creating Entity Sets

Creating Associations

Creating Referential Constraints

Defining Navigation Properties

Navigations Replace MBO Synchronization Groups

Creating Association Sets

Generating Runtime Objects

Testing the OData Service

Implement GET_ENTITYSET for Defined Entities

Implementing the BUSINESSPARTNERS_GET_ENTITYSET Method

Implementing the SALESORDERS_GET_ENTITYSET Method

Implementing the SALESORDERITEMS_GET_ENTITYSET Method

Testing GET_ENTITYSET Implementations

Implement GET_ENTITY for SalesOrder and BusinessPartner

Implementing GET_ENTITY for SalesOrder

Implementing GET_ENTITY for BusinessPartner

Testing the GET_ENTITY Implementations and Navigation Functionality

Implement Filters to Replace Parameters and Personalization Keys

Implementing a Filter for BUSINESSPARTNERS_GET_ENTITYSET

Implementing a Filter for SALESORDERS_GET_ENTITYSET

Create, Update, and Delete Entities

Implementing CREATE_ENTITY

Implementing UPDATE_ENTITY

Implementing DELETE_ENTITY

Delta Query Support for OData Services Exposed in NetWeaver Gateway

Understanding Delta Query Support

Delta Tokens

Tombstones

Structure of a Delta Query Enabled OData Service

GET_ENTITYSET Method

GET_ENTITYSET_DELTA Method

Implementing Delta Queries

Implementing Delta Query Support with Syclo Exchange Tables

Creating Tables, Structures, and Triggers

Creating Exchange Objects in Syclo

Configuring Delta Tokens

Tracking Entity Data Changes with Change Pointer Tables

Retrieving Entity Set Deltas

Implementing Delta Queries with ABAP-Based Delta Request Log

Redefining the GET_ENTITYSET Method

Redefining the GET_ENTITYSET_DELTA Method

Testing the Delta Query Service

Filtering a Delta Queried Entity Set

Migrating Agentry Applications

Preparing Agentry Applications With Java System Connections

Migrating Agentry Applications from SAP Mobile Platform 2.3 to 3.0

Migrating Agentry 5.x/6.0.x Applications to SAP Mobile Platform 3.0

Porting Agentry Applications to iOS 7 Look and Feel

Glossary: SAP Mobile Platform

Important Disclaimers on Legal Aspects

Copyright / Legal Notice