

Record Cursor

Provide functions to work with kintone Cursor

Currently there's only cursor for records.

Constructor

Parameter

Name	Type	Required	Description
connection	Connection	(optional)	The connection module of this SDK. If initializing in browser environment on kintone, this parameter can be ommited to use session authentication.

Sample code

Init Record Cursor module

Javascript

    (function(kintoneJSSDK) {
        'use strict';
        const kintoneConnection = kintoneJSSDK.Connection;
        const kintoneRecordCursorModule = kintoneJSSDK.RecordCursor;

        // Init Connection
        const conn = new kintoneConnection();

        // Init RecordCursor module
        const kintoneRC = new kintoneRecordCursorModule(conn)

        //...
    }(window.kintoneJSSDK));

Nodejs

    const kintone = require('@kintone/kintone-js-sdk');

    const username = 'YOUR_USERNAME';
    const password = 'YOUR_PASSWORD';
    const domain = 'YOUR_DOMAIN';
    const appID = YOUR_APP_ID;

    const kintoneAuth = (new kintone.Auth()).setPasswordAuth(username, password);
    const kintoneConn = new kintone.Connection(domain, kintoneAuth);

    const kintoneRC = new kintone.RecordCursor(kintoneConn);

Methods

createCursor(option)

Create a cursor.

Parameter

Name	Type	Required	Description
option	Object	yes	Cursor option
option.app	Integer	yes	The kintone app ID
option.fields	Array<String>	(optional)	List of field codes you want in the response.
option.query	String	(optional)	The query string that will specify what records will be responded.
option.size	Integer	(optional)	Number of records to retrieve per request. Default: 100. Maximum: 500.

Return

Promise<CreateCursorResponse> Cursor Object from kintone.

Name	Type	Description
id	String	The cursor ID
totalCount	Integer	The total count of records that match the query conditions

Sample code

Init Record Cursor module

Javascript

    (function(kintoneJSSDK) {
        'use strict';
        const kintoneConnection = kintoneJSSDK.Connection;
        const kintoneRecordCursorModule = kintoneJSSDK.RecordCursor;

        // Init Connection
        const conn = new kintoneConnection();

        // Init RecordCursor module
        const kintoneRC = new kintoneRecordCursorModule(conn)

        const rcOption = {
            app: appID,
            fields: [],
            query: '',
            size: 2
        }

        kintoneRC.createCursor(rcOption)
            .then(function(creatCursorResponse){
                const myCursor = creatCursorResponse;
                console.log('Cursor ID: ' + myCursor.id );
                console.log('Total Count: ' + myCursor.totalCount );
            })
    }(window.kintoneJSSDK));

Nodejs

    const kintone = require('@kintone/kintone-js-sdk');

    const username = 'YOUR_USERNAME';
    const password = 'YOUR_PASSWORD';
    const domain = 'YOUR_DOMAIN';
    const appID = YOUR_APP_ID;

    const kintoneAuth = (new kintone.Auth()).setPasswordAuth(username, password);
    const kintoneConn = new kintone.Connection(domain, kintoneAuth);

    const kintoneRC = new kintone.RecordCursor(kintoneConn);

    const rcOption = {
        app: appID,
        fields: [],
        query: '',
        size: 2
    }

    kintoneRC.createCursor(rcOption)
        .then(function(creatCursorResponse){
            const myCursor = creatCursorResponse;
            console.log('Cursor ID: ' + myCursor.id );
            console.log('Total Count: ' + myCursor.totalCount );
        })

getRecords(cursorID)

Get one block of records.

Parameter

Name	Type	Required	Description
cursorID	String	yes	Cursor ID

Return

Promise<GetRecordCursorResponse>

Name	Type	Description
records	Array	The array of records data
next	Boolean	Show states whether there are more records to get from kintone of cursor.

Sample code

Get Records Once

Javascript

    kintoneRC.getRecords(myCursor.id)
        .then(function(getRecordsResponse){
            console.log('RecordCursor result: ');
            console.log(getRecordsResponse);
        })

Nodejs

    kintoneRC.getRecords(myCursor.id)
        .then((getRecordsResponse) => {
            console.log('RecordCursor result: ');
            console.log(getRecordsResponse);
        })

getAllRecords(cursorID)

Get all records

Parameter

Name	Type	Required	Description
cursorID	String	yes	Cursor ID

Return

Promise<GetRecordsResponse>

Name	Type	Description
records	Array	The array of records data
totalCount	Integer	The number of records response.

Sample code

Get All Records

Javascript

    kintoneRC.getAllRecords(myCursor.id)
        .then(function(getAllRecordsResponse){
            console.log('RecordCursor result: ');
            console.log(getAllRecordsResponse);
        })

Nodejs

    kintoneRC.getAllRecords(myCursor.id)
        .then((getAllRecordsResponse) => {
            console.log('RecordCursor result: ');
            console.log(getAllRecordsResponse);
        })

deleteCursor(cursorID)

Delete a cursor

Parameter

Name	Type	Required	Description
cursorID	String	yes	Cursor ID

Return

None

Sample code

Delete Cursor

Javascript

    kintoneRC.deleteCursor(myCursor.id)
        .then(function(){
            console.log('Cursor Deleted');
        })
        .catch(function(error){
            console.log('Delete cursor fail');
            console.log(error)
        })

Nodejs

    kintoneRC.deleteCursor(myCursor.id)
        .then(function(){
            console.log('Cursor Deleted');
        })
        .catch(function(error){
            console.log('Delete cursor fail');
            console.log(error)
        })