cordova-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (CB-10206) *sdkVersion preferences are not documented
Date Tue, 09 Feb 2016 05:13:18 GMT

    [ https://issues.apache.org/jira/browse/CB-10206?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15138367#comment-15138367
] 

ASF GitHub Bot commented on CB-10206:
-------------------------------------

Github user omefire commented on a diff in the pull request:

    https://github.com/apache/cordova-docs/pull/490#discussion_r52268466
  
    --- Diff: www/docs/en/dev/config_ref/index.md ---
    @@ -131,82 +131,85 @@ platform. See [Icons and Splash Screens](images.html) for more information.
             <content src="startPage.html"></content>
         </widget>
     
    -    
    +
     ## access
    -   Defines the set of external domains the app is allowed to communicate with. The default
value shown above allows it to access any server. 
    -   See the Domain [Whitelist Guide](../guide/appdev/whitelist/index.html) for details.

    +   Defines the set of external domains the app is allowed to communicate with. The default
value shown above allows it to access any server.
    +   See the Domain [Whitelist Guide](../guide/appdev/whitelist/index.html) for details.
     
        Attributes(type) | Description
        ----------------- | ------------
    -   origin(string) | *Required* <br/> Defines the set of external domains the app
is allowed to communicate with. 
    -   The default value shown above allows it to access any server. 
    -   See the Domain [Whitelist Guide](../guide/appdev/whitelist/index.html) for details.

    +   origin(string) | *Required* <br/> Defines the set of external domains the app
is allowed to communicate with.
    +   The default value shown above allows it to access any server.
    +   See the Domain [Whitelist Guide](../guide/appdev/whitelist/index.html) for details.
     
        Examples:
     
         <widget ...>
             <access origin="*"></content>
         </widget>
    -    
    +
         <widget ...>
             <access origin="http://google.com"></content>
         </widget>
    -    
    -    
    +
    +
     ## allow-navigation
        Controls which URLs the WebView itself can be navigated to. Applies to top-level navigations
only.
    -   
    +
        Attributes(type) | Description
        ----------------- | ------------
    -   href(string) | *Required* <br/> Defines the set of external domains the WebView
is allowed to navigate to. 
    +   href(string) | *Required* <br/> Defines the set of external domains the WebView
is allowed to navigate to.
        See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#navigation-whitelist)
for details.
    -   
    +
        Examples:
    -   
    +
         <!-- Allow links to example.com -->
         <allow-navigation href="http://example.com/*" />
     
         <!-- Wildcards are allowed for the protocol, as a prefix to the host, or as a
suffix to the path -->
         <allow-navigation href="*://*.example.com/*" />
    -   
    +
     ## allow-intent
        Controls which URLs the app is allowed to ask the system to open. By default, no external
URLs are allowed.
    -   
    +
        Attributes(type) | Description
        ----------------- | ------------
    -   href(string) | *Required* <br/> Defines which URLs the app is allowed to ask
the system to open. 
    +   href(string) | *Required* <br/> Defines which URLs the app is allowed to ask
the system to open.
        See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#intent-whitelist)
for details.  
    -  
    +
        Examples:
    -   
    +
         <allow-intent href="http://*/*" />
         <allow-intent href="https://*/*" />
         <allow-intent href="tel:*" />
         <allow-intent href="sms:*" />
    -  
    +
     ## engine
        Specifies what platform to restore during a prepare. For more details, see the [Platforms
& Plugins Version Management](../platform_plugin_versioning_ref/index.html).
    -   
    +
        Attributes(type) | Description
        ----------------- | ------------
        name(string) | *Required* <br/> Name of the platform to be restored
        spec(string) | *Required* <br/> Version of the platform to be restored
    -   
    +
        Examples:
     
         <engine name="android" spec="^4.0.0" />
    -    
    +
     ## preference
        Sets various options as pairs of name/value attributes. Each preference's name is
case-insensitive. Many preferences are unique to specific platforms,
        and will be indicated as such.  
     
        Attributes(type) | Description
        ----------------- | ------------
    -   AllowInlineMediaPlayback(boolean) | *Default: false* <br/> ==iOS== <br/>
Set to true to allow HTML5 media playback to appear inline within the screen layout, using
browser-supplied controls rather than native controls. For this to work, add the webkit-playsinline
attribute to any ```<video>``` elements. 
    -   AndroidLaunchMode(string) | *Default: singleTop* <br/> Allowed values: standard,
singleTop, singleTask, singleInstance <br/> ==Android== <br/> Sets the Activity
android:launchMode attribute. This changes what happens when the app is launched from app
icon or intent and is already running. 
    +   AllowInlineMediaPlayback(boolean) | *Default: false* <br/> ==iOS== <br/>
Set to true to allow HTML5 media playback to appear inline within the screen layout, using
browser-supplied controls rather than native controls. For this to work, add the webkit-playsinline
attribute to any ```<video>``` elements.
    +   AndroidLaunchMode(string) | *Default: singleTop* <br/> Allowed values: standard,
singleTop, singleTask, singleInstance <br/> ==Android== <br/> Sets the Activity
android:launchMode attribute. This changes what happens when the app is launched from app
icon or intent and is already running.
    +   android-maxSdkVersion(integer) | *Default: Not Specified* <br/> ==Android==
<br/> Sets the `maxSdkVersion` attribute of the `<uses-sdk>` tag in the project's
`AndroidManifest.xml` (see [uses-sdk][uses-sdk]).
    --- End diff --
    
    How about providing a link to the Android docs ? : http://developer.android.com/guide/topics/manifest/uses-sdk-element.html


> *sdkVersion preferences are not documented
> ------------------------------------------
>
>                 Key: CB-10206
>                 URL: https://issues.apache.org/jira/browse/CB-10206
>             Project: Apache Cordova
>          Issue Type: Improvement
>          Components: Docs
>    Affects Versions: 5.4.1
>            Reporter: Frederico Costa Galv√£o
>            Assignee: Richard B Knoll
>            Priority: Minor
>              Labels: Docs-6.x, android, config.xml, cordova-lib, docs, triaged
>
> Neither of the following preferences handled by *cordova-lib/src/cordova/metadata/android_parser.js*
are currently documented at *cordova-docs/www/docs/en/5.4.0/guide/platforms/android/config.md*:
> {code}['minSdkVersion', 'maxSdkVersion', 'targetSdkVersion']{code}



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For additional commands, e-mail: issues-help@cordova.apache.org


Mime
View raw message