Skip to content

A few cleanup changes to the documentation #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

A few cleanup changes to the documentation #12

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5d61957
correcting minor variable missing
jazmatician Mar 3, 2017
4880735
Minor typo & English syntax changes.
jazmatician Mar 3, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ var fetchxml = [
' </entity>',
'</fetch>'].join('');

var CrmFetchKit.FetchMoreSync(fetchxml);
var response = CrmFetchKit.FetchMoreSync(fetchxml);

console.log(response.totalRecordCount);
console.log(response.moreRecords);
Expand All @@ -173,7 +173,7 @@ for(var i = 0, max = response.entities; i < max; i++){

````
## FetchAll
To address the 5.000 records query limit of Dynamics CRM (a single request return at a maximum 5.000 records) provides the CrmFetchKit with the `FetchAll` method an option to load all records retunred by an query.
To address the 5.000 record query limit of Dynamics CRM (a single request return at a maximum 5.000 records) the CrmFetchKit provides the `FetchAll` method as an option to load all records returned by a query.

**Note:** This method supports only the asynchronous execution.
````javascript
Expand All @@ -193,7 +193,7 @@ CrmFetchKit.FetchAll(fetchxml).then(function(entities){
}
});
````
Internally uses `FetchAll` the `FetchMore` method and the provided `pagingCookie` to load the pages until all records are loaded.
Internally `FetchAll` uses the `FetchMore` method and the provided `pagingCookie` to load the pages until all records are loaded.

## FetchByPage
This method allows the load of records per page-number.
Expand Down Expand Up @@ -231,7 +231,7 @@ var contactid = '06569fb8-88d0-4588-bdb8-c20c19e29205',

CrmFetchKit.AssignSync(contactid, 'contact', teamid, 'team');
````
**Note:** The parameter for this method have change form the 1.x version of the CrmFetchKit. The old version supported only the assignment of `SystemUsers` where the current version supports `Teams` and `SystemUsers`.
**Note:** The parameter for this method have change from the 1.x version of the CrmFetchKit. The old version supported only the assignment of `SystemUsers` where the current version supports `Teams` and `SystemUsers`.

## Promise Member
Since version 3.3.0 support exposes the library the object `Promise`. This is only the reference
Expand Down Expand Up @@ -327,11 +327,11 @@ This version replaced [jQuery](http://jquery.com/) dependency with [bluebird](ht
- `fail` instead use `catch`

### Breaking Changes
The optional `async` for `Fetch`, `FetchMore` and `Assign` is no longer supported. All methods are now async. That means that `CrmFetchKit.Fetch(xml, false)` will **not** perform a synchronous operation. To execute a sync operation use one of the `*Sync` methods (e.g. `FetchSync`, `FetchMoreSync`).
The optional `async` for `Fetch`, `FetchMore` and `Assign` is no longer supported. All methods are now async. That means that `CrmFetchKit.Fetch(xml, false)` will **not** perform a synchronous operation. To execute a sync operation, use one of the `*Sync` methods (e.g. `FetchSync`, `FetchMoreSync`).

Furthermore supports the library now the methods `GetById` and `GetByIdSync`.

**Note:** Unfortunately depends `CrmRestKit.js` (use for the integration-tests) still jQuery. Therefor is it not possible to remove the jQuery dependency for now.
**Note:** Unfortunately `CrmRestKit.js` (use for the integration-tests) still depends on jQuery. Therefore is it not possible to remove the jQuery dependency for now.

Internally uses CrmFetchKit now [browserify](http://browserify.org/) for the dependency management.

Expand Down