Actions of Fabasoft Mobile Apps (FSCMOBILEAPPS@1.1001)

ReferenceName
FSCMOBILEAPPS@1.1001:CheckVersionedContents
FSCMOBILEAPPS@1.1001:GenerateTranslations
FSCMOBILEAPPS@1.1001:GetDomainConnections
FSCMOBILEAPPS@1.1001:GetMobileAppConfiguration
FSCMOBILEAPPS@1.1001:GetMobileAppCreatableClasses
FSCMOBILEAPPS@1.1001:SearchInBackend

FSCMOBILEAPPS@1.1001:CheckVersionedContents

Will check all entries of the CheckContentVersion array, whether the defined hash with the given size is already available in any version for the object.
Each object in the CheckContentVersion array must be a sub class of ContentObject. Otherwise the respective ContentVersion will contain a JSAPIError with #invalid_value.
This method should be used to verify, if a change to the objects' content was successful. When a version number is available it means, that the content is already successfully versioned.
ParameterTypeIn/OutOptionalDescription
checklistFSCMOBILEAPPS@1.1001:CheckContentVersioninfalse the list of entries to check
resultFSCMOBILEAPPS@1.1001:ContentVersionoutfalse the list of results

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCMOBILEAPPS@1.1001:GenerateTranslations

Will return all strings from this component in an array of contents and an according array of language codes in the requested format.
The strings can be attached by multiple projects, therefore only the part before the first "_" will be taken. Some strings need to be generated as string-array (android only). When the string reference ends with "_isarray_#", the part will be cut off and a proper string-array will be created with all the items in the ascending order like the #.
Example:
When platform = "ios":
  • StrSomething_cmis_workflow
    • becomes to (for project = "_cmis")
      • StrSomething = "The something text"
    • becomes to (for project = "_workflow")
      • StrSomething = "The something text"
  • StrSomethingAsArray_isarray_1_cmis becomes to
    nothing as it is not supported for ios.
When platform = "android":
  • StrSomething_cmis_workflow
    • becomes to (for project = "_cmis")
      • <string name="StrSomething">The something text<string>
    • becomes to (for project = "_workflow")
      • <string name="StrSomething">The something text<string>
  • StrSomethingAsArray_isarray_1_cmis_faba5
  • StrSomethingAsArray_isarray_2_cmis
  • StrSomethingAsArray_isarray_3_cmis_faba5
    • becomes to (for project = "_cmis"):
      • <string-array name="StrSomethingAsArray">
        • <item>The first text of this array.</item>
        • <item>The second text of this array.</item>
        • <item>The third text of this array.</item>
      • </string-array>
    • becomes to (for project = "_faba5"):
      • <string-array name="StrSomethingAsArray">
        • <item>The first text of this array.</item>
        • <item>The third text of this array.</item>
      • </string-array>
ParameterTypeIn/OutOptionalDescription
platformCOOSYSTEM@1.1:STRINGinfalse define for which platform the contents should be prepared -> ios or android.
projectCOOSYSTEM@1.1:STRINGinfalse the project defines the last part of the string reference which will actually be cut off. So the strings can be defined for each project in one single component, but the actual reference will be beautified for easier usage.
contentsCOOSYSTEM@1.1:CONTENTLISToutfalse the array of contents which contains all strings in the proper format for the given platform
langcodesCOOSYSTEM@1.1:STRINGLISToutfalse the array of language codes for which the contents were created.
forlangsCOOSYSTEM@1.1:OBJECTLISTinfalse an array of languages can be provided. If nothing is defined, all available languages will be used.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCMOBILEAPPS@1.1001:GetDomainConnections

Will return list of domain connections.
ParameterTypeIn/OutOptionalDescription
resultFSCMOBILEAPPS@1.1001:ActiveDomainConnectionoutfalse the result containing the domain connections
errorsFSCOWSSTDSERVICES@1.1001:JSAPIErroroutfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCMOBILEAPPS@1.1001:GetMobileAppConfiguration

Will return the allowed login methods, the current and mandatory version and the allowed object classes for root for the defined platform and app type
ParameterTypeIn/OutOptionalDescription
platformFSCMOBILEAPPS@1.1001:MobileAppPlatforminfalse define the platform like iOS (1) or Android (2)
typeFSCMOBILEAPPS@1.1001:MobileAppTypeinfalse define the app type like Cloud (1), Folio (2) or eGov (3)
resultFSCMOBILEAPPS@1.1001:MobileAppConfigurationoutfalse the result containing the specific configuration
errorsFSCOWSSTDSERVICES@1.1001:JSAPIErroroutfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCMOBILEAPPS@1.1001:GetMobileAppCreatableClasses

Will return the definition and the list of object classes that are allowed to be created for the defined object class in the specified property.
ParameterTypeIn/OutOptionalDescription
objectclassCOOSYSTEM@1.1:OBJECTinfalse can define the Object Class for which to get the allowed creatable object classes (default is COOSYSTEM@1.1:RootObject)
targetattrdefCOOSYSTEM@1.1:OBJECTinfalse can define the Property for which to get the allowed creatable object classes (default is COOSYSTEM@1.1:objchildren or FSCTEAMROOM@1.1001:trchildren)
resultFSCMOBILEAPPS@1.1001:MobileAppConfigurationoutfalse the result containing only the allowed classes and allowed classes definition
errorsFSCOWSSTDSERVICES@1.1001:JSAPIErroroutfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCMOBILEAPPS@1.1001:SearchInBackend

Will search in Folio backend for the defined query in the configured object classes defined by the reference
When Mindbreeze is available and FSCMINDBREEZE@1.1001:fscmbportalwebclientsvcurl is configured it is not permitted to use this web service.
ParameterTypeIn/OutOptionalDescription
referenceCOOSYSTEM@1.1:STRINGinfalse define the reference to get configuration from customization point FSCMOBILEAPPS@1.1001:CPGetMobileAppSearchCategories
queryCOOSYSTEM@1.1:STRINGinfalse define the query to search for
resultFSCMOBILEAPPS@1.1001:MobileAppSearchResultoutfalse the result containing the returned search hits for the query
errorsFSCOWSSTDSERVICES@1.1001:JSAPIErroroutfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]