NATALIE NINE | DESIGN

Writing Samples

API Template

General description of application functionality.

Any basis or dependencies on other API specifications.

WARNING: Any known potential security or privacy linitations or risks.

METHODS

ARGUMENTS

OBJECTS

ACCESSING THE FEATURE

Version and device-level plugin information. Command line interface steps to add or remove the feature.

$ application plugin add org.apache.application.feature
$ application plugin ls
[ 'org.apache.application.feature']
$ application plugin rm org.apache.application.feature

Platform specific configuration settings:

  • Amazon Fire Os
[path/configurationfile.xml]
<feature name="application">
 <param name="android-package" value="org.apache.application.feature.param" />
</feature>

(in path/app/AndroidManifest.xml)
<uses-permission android:name="android.permission.ACCESS_FEATURE_ONE" />
<uses-permission android:name="android.permission.ACCESS_FEATURE_TWO" />

  • Android
[path/configurationfile.xml]
<feature name="application">
 <param name="android-package" value="org.apache.application.feature.param" />
</feature>

(in path/app/AndroidManifest.xml)
<uses-permission android:name="android.permission.ACCESS_FEATURE_ONE" />
<uses-permission android:name="android.permission.ACCESS_FEATURE_TWO" />

  • Blackberry
[path/configurationfile.xml]
<feature name="application"> value="application">
<rim:permissions>
 <rim:permit>read_application</rim:permit>
</rim:permissions>

  • FirefoxOS
[path/manifest.webapp file]
"permissions": {
 "application": { "description": "Feature description" }
}

  • iOS
[path/configurationfile.xml]
<feature name="application">
 <param name="ios-package" value="IOSValue" />
</feature>

  • Windows Phone
[path/Properties/WPAppManifest.xml]
<Capabilities>
 <Capability Name="ID_CAP_APPLICATION" />
</Capabilities>

application.getMethodOne

Description of method functionality and what it returns.

PARAMETERS:

  • Parameter 1: [Required|Optional] functional description.
  • Parameter 2: [Required|Optional] functional description.
  • Parameter 3: [Required|Optional] functional description.

PLATFORMS:

  • Amazon Fire OS
  • Android
  • BlackBerry 10
  • iOS
  • Windows Phone

application.getMethodTwo

Description of method functionality and what it returns.

PARAMETERS:

  • Parameter 1: [Required|Optional] functional description.
  • Parameter 2: [Required|Optional] functional description.
  • Parameter 3: [Required|Optional] functional description.

PLATFORMS:

  • Amazon Fire OS
  • Android
  • BlackBerry 10
  • iOS
  • Windows Phone

application.getMethodThree

Description of method functionality and what it returns.

PARAMETERS:

  • Parameter 1: [Required|Optional] functional description.
  • Parameter 2: [Required|Optional] functional description.
  • Parameter 3: [Required|Optional] functional description.

PLATFORMS:

  • Amazon Fire OS
  • Android
  • BlackBerry 10
  • iOS
  • Windows Phone

ObjectOne

Description of object passed to and callback process.

PROPERTIES:

  • Property 1: Description | Returns | Required
  • Property 2: Description | Returns | Required
  • Property 3: Description | Returns | Required

Constants:

  • ConstantOne.VALUE
  • ConstantTwo.VALUE
  • ConstantThree.VALUE

PLATFORMS:

  • Amazon Fire OS
  • Android
  • BlackBerry 10
  • iOS
  • Windows Phone

ObjectTwo

Description of object passed to and callback process.

PROPERTIES:

  • Property 1: Description | Returns | Required
  • Property 2: Description | Returns | Required
  • Property 3: Description | Returns | Required

Constants:

  • ConstantOne.VALUE
  • ConstantTwo.VALUE
  • ConstantThree.VALUE

PLATFORMS:

  • Amazon Fire OS
  • Android
  • BlackBerry 10
  • iOS
  • Windows Phone

ObjectThree

Description of object passed to and callback process.

PROPERTIES:

  • Property 1: Description | Returns | Required
  • Property 2: Description | Returns | Required
  • Property 3: Description | Returns | Required

Constants:

  • ConstantOne.VALUE
  • ConstantTwo.VALUE
  • ConstantThree.VALUE

PLATFORMS:

  • Amazon Fire OS
  • Android
  • BlackBerry 10
  • iOS
  • Windows Phone