Skip to content
This repository has been archived by the owner on Feb 12, 2022. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
updating readme and other docs
  • Loading branch information
Akhilesh Gupta committed May 25, 2015
1 parent 6ec3158 commit 18a5949
Show file tree
Hide file tree
Showing 12 changed files with 139 additions and 196 deletions.
301 changes: 122 additions & 179 deletions README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion bower.json
Expand Up @@ -7,7 +7,7 @@
"jquery": "latest",
"underscore": "latest",
"backbone": "latest",
"mobilesdk-shared": "forcedotcom/SalesforceMobileSDK-Shared",
"mobilesdk-shared": "forcedotcom/SalesforceMobileSDK-Shared#unstable",
"ratchet": "twbs/ratchet#>=2.0.2"
},
"devDependencies": {
Expand Down
10 changes: 5 additions & 5 deletions elements/force-signin/force-signin.html
Expand Up @@ -35,7 +35,7 @@
is: 'force-signin',
properties: {
/**
* Automatically trigger user authentication as soon as the component is ready.
* Automatically trigger user authentication as soon as the component is ready. If accesstoken and instanceurl are set via attributes, OAuth will not trigger automatically.
*
* @attribute auto
* @type Boolean
Expand Down Expand Up @@ -87,7 +87,7 @@
usePopupWindow: Boolean,

/**
* Salesforce session ID for API requests. It can directly specified for a known session ID, or will be obtained automatically via OAuth.
* Salesforce session ID for API requests. It is set by the component after successful completion of Salesforce OAuth.
*
* @attribute accesstoken
* @type String
Expand All @@ -98,7 +98,7 @@
},

/**
* Salesforce instance URL for API requests. It can directly specified for a known salesforce host, or will be obtained automatically via OAuth.
* Salesforce instance URL for API requests. It is set by the component after successful completion of Salesforce OAuth.
*
* @attribute instanceurl
* @type String
Expand All @@ -109,9 +109,9 @@
},

/**
* Salesforce user identity URL. It can directly specified for a known user, or will be obtained automatically via OAuth.
* Salesforce user identity URL. It is set by the component after successful completion of Salesforce OAuth.
*
* @attribute idUrl
* @attribute id-url
* @type String
*/
idUrl: {
Expand Down
Expand Up @@ -4,7 +4,7 @@
-->

<!--
force-sobject-collection element provides a custom component for Force.SObjectCollection from Mobile SDK's SmartSync JS. It allows apps to easily fetch a list of records from a salesforce sobject in both online & offline modes. For Offline use, the application should first create a Smartstore soup with same name as the target sobject.
force-sobject-collection element provides a custom component for `Force.SObjectCollection` from Mobile SDK's SmartSync JS. It allows apps to easily fetch a list of records from a salesforce sobject in both online & offline modes. For Offline use, the application should first create a Smartstore soup with same name as the target sobject.
To use this component, specify the sobject name and the query for fetching data.
Expand Down
6 changes: 3 additions & 3 deletions elements/force-sobject-layout/force-sobject-layout.js
Expand Up @@ -54,7 +54,7 @@
sobject: String,

/**
* (Optional) If false, the element returns the default layout. Set true if the sobject has recordtypes or if you are unsure. If set to true, "recordid" or "recordtypeid" must be provided.
* (Optional) If false, the element returns the default layout. Set true if the sobject has recordtypes or if you are unsure. If set to true, `recordid` or `recordtypeid` must be provided.
*
* @attribute hasrecordtypes
* @type Boolean
Expand All @@ -66,7 +66,7 @@
},

/**
* (Optional) Id of the record type for which layout has to be fetched. Required if "hasrecordtypes" is true and "recordid" is not provided.
* (Optional) Id of the record type for which layout has to be fetched. Required if `hasrecordtypes` is true and `recordid` is not provided.
*
* @attribute recordtypeid
* @type String
Expand All @@ -78,7 +78,7 @@
},

/**
* (Optional) Id of the record for which layout has to be fetched. Required if "hasrecordtypes" is true and "recordtypeid" is not provided.
* (Optional) Id of the record for which layout has to be fetched. Required if `hasrecordtypes` is true and `recordtypeid` is not provided.
*
* @attribute recordid
* @type String
Expand Down
2 changes: 1 addition & 1 deletion elements/force-sobject-store/force-sobject-store.html
Expand Up @@ -4,7 +4,7 @@
-->

<!--
force-sobject-store element provides a custom component for Force.StoreCache from Mobile SDK's SmartSync JS. It allows an app to quickly create and manage Smartstore soup for a salesforce sobject.
force-sobject-store element provides a custom component for `Force.StoreCache` from Mobile SDK's SmartSync JS. It allows an app to quickly create and manage Smartstore soup for a salesforce sobject.
To use this component just specify the sobject name.
Expand Down
2 changes: 1 addition & 1 deletion elements/force-sobject/force-sobject.html
Expand Up @@ -4,7 +4,7 @@
-->

<!--
force-sobject element provides a custom component for Force.SObject from Mobile SDK's SmartSync JS. It allows apps to easily perform CRUD operations against a salesforce sobject in both online & offline modes. For Offline use, the application should first create a Smartstore soup with same name as the target sobject.
force-sobject element provides a custom component for `Force.SObject` from Mobile SDK's SmartSync JS. It allows apps to easily perform CRUD operations against a salesforce sobject in both online & offline modes. For Offline use, the application should first create a Smartstore soup with same name as the target sobject.
To use this component, specify the sobject name and the recordid.
Expand Down
2 changes: 1 addition & 1 deletion elements/force-sobject/force-sobject.js
Expand Up @@ -111,7 +111,7 @@
},

/**
* Returns a map of fields to values for a specified record. Update this map before saving changes.
* Returns a map of fields to values for a specified record. Update this map to change SObject field values.
*
* @attribute fields
* @type Object
Expand Down
2 changes: 1 addition & 1 deletion elements/force-ui-detail/force-ui-detail.html
Expand Up @@ -4,7 +4,7 @@
-->

<!--
force-ui-detail element enables the rendering of full view of a salesforce record. This element uses the `force-sobject-layout` element to fetch the page layout for the record. This element also embeds a `force-sobject` element to allow all the CRUD operations on an SObject.
force-ui-detail element enables the rendering of full view of a salesforce record. This element uses the `force-sobject-layout` element to fetch the page layout for the record. This element also embeds a `force-sobject` element to allow all the CRUD operations on an SObject. This element should always be a child of `force-ui-app` element to inherit the default styles.
To use this component, specify the sobject name and the recordid.
Expand Down
2 changes: 1 addition & 1 deletion elements/force-ui-list/force-ui-list.html
Expand Up @@ -4,7 +4,7 @@
-->

<!--
force-ui-list element enables the rendering of simple list of salesforce records driven by a `force-sobject-collection`. It uses the iron-selector element to detect record selection based on user's tap actions.
force-ui-list element enables the rendering of simple list of salesforce records driven by a `force-sobject-collection`. It uses the iron-selector element to detect record selection based on user's tap actions. This element should always be a child of `force-ui-app` element to inherit the appropriate styles.
To use this component, specify the sobject name and the query.
Expand Down
2 changes: 1 addition & 1 deletion elements/force-ui-relatedlist/force-ui-relatedlist.html
Expand Up @@ -28,7 +28,7 @@
</dom-module>

<!--
force-ui-relatedlist element renders a list of records for a SObject's related list configuration. It uses the iron-selector element to detect record selection based on user's tap actions.
force-ui-relatedlist element renders a list of records for a SObject's related list configuration. It uses the iron-selector element to detect record selection based on user's tap actions. This element should always be a child of `force-ui-app` element to inherit the default styles.
To use this component, specify a related list configuration obtained from `force-sobject-relatedlist`.
Expand Down
2 changes: 1 addition & 1 deletion elements/force-ui-relatedlist/force-ui-relatedlist.js
Expand Up @@ -50,7 +50,7 @@
},

/**
* An array of all the related list information.
* Returns an array of all the related list information.
*
* @attribute relatedLists
* @type Array
Expand Down

0 comments on commit 18a5949

Please sign in to comment.