Javascript SDK

Rio has an SDK for Javascript / Typescript. You need to have a Rio projectId to use our SDK.

Firstly, we need to install Rio JS sdk. Rio SDK's eases you to call methods and allows you to authenticate clients with Rio. You can see how to use the sdk on github repo.

Installation

npm install @retter/sdk

Now, we can initiate sdk with projectId. You can find project id from console's home page.

import Rio from '@retter/sdk'


const rio = Rio.getInstance({
    projectId: '{your-project-id}'
})

Get A Cloud Object

We can get an existing class' cloud object from sdk.

const todoObject = await rio.getCloudObject({
    classId: 'Todo' // previously created class
})

Call A Method On A Cloud Object

With cloud object, we can access several methods and properties. We can call methods with call method, get the current instance with instanceId, etc.

To continue with demo, let's call the createTodo method with todo item. This methods required task field from body.

await todoObject.call({
    method: 'createTodo',
    body: {
        task: 'Buy tickets for latest Robert Pattinson movie'
    }
})

Now, we can fetch todos. On listTodos method, we returned an items array. We can reach them from response.

const response = await todoObject.call({
    method: 'listTodos'
})


const items = response.body.items
/**
    Output:
    [
        {
            "task": "Buy tickets for latest Robert Pattinson movie",
            "isCompleted": false
        }
    ]
*/

To mark the task as completed, we can call markTodoAsCompleted method with task.

await todoObject.call({
    method: 'markTodoAsCompleted',
    body: {
        task: "Buy tickets for latest Robert Pattinson movie"
    }
})

If we list todo items now, we can see isCompleted field as true.

[
    {
        "task": "Buy tickets for latest Robert Pattinson movie",
        "isCompleted": false
    }
]

We can also take realtime updates from cloud objects. Because of updating public state (in previous article), we can subscribe the public state. When a new item created or existing one is updated, we will be notified.

todoObject.state.public.subscribe(state => {
    const items = state.items


    /*
    [
        {
            "task": "Buy tickets for latest Robert Pattinson movie",
            "isCompleted": true
        }
    ]
    */
})

That's it. It is simple as that.