NSB App Studio - User contributions [en]

Volt Documentation

2017-05-27T03:45:34Z

Sarah: Added API and JS Docs links

Volt is a platform to electrify your web apps. It provides simple hosting and extended services for your web and mobile apps. As a web host, it provides an easy to use interface to deploy apps, custom names using full HTTPS on a fast, stable platform.

Extended services like user management and server storage are available.

== Getting Started ==
* [[faq|Frequently Asked Questions]]
* [[first_app|Your First Volt App]]
* [[error_handling|Handling Errors]]

== Authentication ==
* [[user_confirmation|User Confirmation]]
* [[resetting_passwords|Resetting Passwords]]
* [[user_registration|Register a User]]
* [[log_in|Logging In (and Out)]]

== Users ==
* [[current_user|Working with the Current User]]
* [[manage_users|Managing Your Users]]

== Apps ==
* [[manage_apps|Managing Your Apps]]
* [[Custom Domains]]

== Services ==
* [[server_storage|Server Storage]]
* [[app_storage|App Storage]]
* [[send_email|Sending Email]]

== AppStudio ==
* [[volt_for_appstudio|Volt for AppStudio Users]]

== API Documentation ==
* [https://docs.voltcloud.io/api/ Volt API]

== JS Documentation ==
* [https://docs.voltcloud.io/client/ JS Docs]

Server storage

2017-05-27T01:02:54Z

Sarah: Instructions for creating server storage

Server Storage allows you to save data in (key, value) pairs on the server so it is available next time you run the program. An entry can be created by assigning to appStorage.setItem(''key'', ''value'', ''callback''), where ''key'' is specified by you. Data is retrieved a similar way. The information in serverStorage is only available to the app itself.

The ''value'' can be a string, number, array or object. There is no size limit on value, other than it be reasonable.

If your app does not have a live internet connection, the request will time out and an error message will be passed to callback.

Since the calls access information on a server, they are asynchronous (so your app does not look up while the call is being processed). When the call is complete, the function named in ''callback'' is called in your app. It passes two parameters: (''error'', ''data''). If the call is successful, ''error'' is empty and your results are in ''data''. If the call is unsuccessful, ''error'' is not empty and the error message is in ''data''.message.

serverStorage is an alias for $volt.user.storage in the Volt API.

== serverStorage.clear ==

This call clears all the items in your app's serverStorage.

The syntax of the function is:

'''serverStorage.clear'''(''callback'')

* ''callback'' - function(''error'', ''data''), required. The function in your app to call when the function is complete (or fails).

<syntaxhighlight lang="JavaScript">
butClear.onclick = function() {
serverStorage.clear(done);
};

function done(error, data) {
if (error) {
if (data == undefined) {
data = {
message: "Network Error"
};
}
NSB.MsgBox(data.message);
} else {
console.log("success");
}
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
Function butClear_onclick()
serverStorage.clear(done)
End Function

Function done(error, data)
If error Then
If data = undefined Then data = {message: "Network Error"}
MsgBox data.message
Else
console.log("success")
End If
End Function
</syntaxhighlight>

== serverStorage.getItem ==

This call returns the value of the item with the specified ''key''.

The syntax of the function is:

'''serverStorage.getItem'''(''key'', ''callback'')

* ''key'' - The name of the item. String.
* ''callback'' - function(''error'', ''data''), required. The function in your app to call when the function is complete (or fails).

<syntaxhighlight lang="JavaScript">
butGetItem.onclick = function() {
serverStorage.getItem("SimpleString", getItemCallback);
};

function getItemCallback(error, data) {
if (error) {
if (data == undefined) {
data = {
message: "Network Error"
};
}
alert(data.message);
} else {
alert(data);
}
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
Function butGetItem_onclick()
serverStorage.getItem("SimpleString", getItemCallback)
End Function

Function getItemCallback(error, data)
If error Then
If data = undefined Then data = {message: "Network Error"}
MsgBox data.message
Else
MsgBox data
End If
End Function
</syntaxhighlight>

== serverStorage.getAllItems ==

This call returns all the items in your app's serverStorage in an array of {key, value} objects.

The syntax of the function is:

'''serverStorage.getAllItems'''(''callback'')

* ''callback'' - function(''error'', ''data''), required. The function in your app to call when the function is complete (or fails).

<syntaxhighlight lang="JavaScript">
butGetAllItems.onclick = function() {
serverStorage.getAllItems(getAllItemsCallback);
};

function getAllItemsCallback(error, data) {
if (error) {
if (data == undefined) {
data = {
message: "Network Error"
};
}
NSB.MsgBox(data.message);
} else {
NSB.Print((false) + "<br>");
for (key in data) {
console.log(key, data[key]);
}
}
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
Function butGetAllItems_onclick()
serverStorage.getAllItems(getAllItemsCallback)
End Function

Function getAllItemsCallback(error, data)
If error Then
If data = undefined Then data = {message: "Network Error"}
MsgBox data.message
Else
Print False
For Each key in data
console.log(key, data[key])
k = [key, key][0]
Print k & ": " & data[key].toString()
Next
End If
End Function
</syntaxhighlight>

== serverStorage.removeItem ==

This call removes the item with a specified key.

The syntax of the function is:

'''serverStorage.removeItem'''(''key'', ''callback'')

* ''key'' - The name of the item. String.
* ''callback'' - function(''error'', ''data''), required. The function in your app to call when the function is complete (or fails).

<syntaxhighlight lang="JavaScript">
butRemoveItem.onclick = function() {
serverStorage.removeItem("SimpleString", done);
};

function done(error, data) {
if (error) {
if (data == undefined) {
data = {
message: "Network Error"
};
}
NSB.MsgBox(data.message);
} else {
console.log("success");
}
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
Function butRemoveItem_onclick()
serverStorage.removeItem("SimpleString", done)
End Function

Function done(error, data)
If error Then
If data = undefined Then data = {message: "Network Error"}
MsgBox data.message
Else
console.log("success")
End If
End Function
</syntaxhighlight>

== serverStorage.setItem ==

This call adds a key, value pair to serverStorage.

The syntax of the function is:

'''serverStorage.setItem'''(''key'', ''value'', ''callback'')

* ''key'' - The name of the item. String.
* ''value'' - The name of the item. Can be string, number, array, object: any JavaScript data type.
* ''callback'' - function(''error'', ''data''), required. The function in your app to call when the function is complete (or fails).

<syntaxhighlight lang="JavaScript">
butSetItem.onclick = function() {
serverStorage.setItem("SimpleString", "ABCD", done);
serverStorage.setItem("Number", 123, done);
serverStorage.setItem("Array", [1, 2, 3, 4], done);
serverStorage.setItem("Object", {
firstName: "Eric",
lastName: "Cartman"
}, done);
};

function done(error, data) {
if (error) {
if (data == undefined) {
data = {
message: "Network Error"
};
}
NSB.MsgBox(data.message);
} else {
console.log("success");
}
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
Function butSetItem_onclick()
serverStorage.setItem("SimpleString", "ABCD", done)
serverStorage.setItem("Number", 123, done)
serverStorage.setItem("Array", [1, 2, 3, 4], done)
serverStorage.setItem("Object", {firstName: "Eric", lastName: "Cartman"}, done)
End Function

Function done(error, data)
If error Then
If data = undefined Then data = {message: "Network Error"}
MsgBox data.message
Else
console.log("success")
End If
End Function
</syntaxhighlight>

== Reference ==

* JavaScript API: [https://docs.voltcloud.io/client/$volt.user.storage.html https://docs.voltcloud.io/client/$volt.user.storage.html]
* REST API: [https://docs.voltcloud.io/api/#storage-plug-in https://docs.voltcloud.io/api/#storage-plug-in]

App storage

2017-05-27T00:45:11Z

Sarah: Instructions for creating app storage

App Storage allows you to store data as (key, value) pairs on the server so it is available to all users of an app. An entry can be created by assigning to appStorage.setItem(''key'', ''value'', ''callback''), where ''key'' is specified by you. Data is retrieved a similar way. Apps can only read appStorage. Use the Dashboard to clear, remove or change the entries.

The ''value'' can be a string, number, array or object. There is no size limit on ''value'', other than it be reasonable.

If your app does not have a live internet connection, the request will time out and an error message will be passed to callback.

Since the calls access information on a server, they are asynchronous (so your app does not look up while the call is being processed). When the call is complete, the function named in ''callback'' is called in your app. It passes two parameters: (''error'', ''data''). If the call is successful, ''error'' is empty and your results are in ''data''. If the call is unsuccessful, ''error'' is not empty and the error message is in ''data''.message.

appStorage is an alias for $volt.storage in the Volt API.

== appStorage.clear ==

This call clears all the items in your app's appStorage. It is available in the Dashboard only.

The syntax of the function is:

'''appStorage.clear'''(''callback'')

* ''callback'' - function(''error'', ''data''), required. The function in your app to call when the function is complete (or fails).

<syntaxhighlight lang="JavaScript">
butClear.onclick = function() {
appStorage.clear(done);
};

function done(error, data) {
if (error) {
if (data == undefined) {
data = {
message: "Network Error"
};
}
NSB.MsgBox(data.message);
} else {
console.log("success");
}
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
Function butClear_onclick()
appStorage.clear(done)
End Function

Function done(error, data)
If error Then
If data = undefined Then data = {message: "Network Error"}
MsgBox data.message
Else
console.log("success")
End If
End Function
</syntaxhighlight>

== appStorage.getItem ==

This call returns the value of the item with the specified ''key''.

The syntax of the function is:

'''appStorage.getItem'''(''key'', ''callback'')

* ''key'' - The name of the item. String.
* ''callback'' - function(''error'', ''data''), required. The function in your app to call when the function is complete (or fails).

<syntaxhighlight lang="JavaScript">
butGetItem.onclick = function() {
appStorage.getItem("SimpleString", getItemCallback);
};

function getItemCallback(error, data) {
if (error) {
if (data == undefined) {
data = {
message: "Network Error"
};
}
alert(data.message);
} else {
alert(data);
}
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
Function butGetItem_onclick()
appStorage.getItem("SimpleString", getItemCallback)
End Function

Function getItemCallback(error, data)
If error Then
If data = undefined Then data = {message: "Network Error"}
MsgBox data.message
Else
MsgBox data
End If
End Function
</syntaxhighlight>

== appStorage.getAllItems ==

This call returns all the items in your app's appStorage in an array of {key, value} objects.

The syntax of the function is:

'''appStorage.getAllItems'''(''callback'')

* ''callback'' - function(''error'', ''data''), required. The function in your app to call when the function is complete (or fails).

<syntaxhighlight lang="JavaScript">
butGetAllItems.onclick = function() {
appStorage.getAllItems(getAllItemsCallback);
};

function getAllItemsCallback(error, data) {
if (error) {
if (data == undefined) {
data = {
message: "Network Error"
};
}
NSB.MsgBox(data.message);
} else {
NSB.Print((false) + "<br>");
for (key in data) {
console.log(key, data[key]);
}
}
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
Function butGetAllItems_onclick()
appStorage.getAllItems(getAllItemsCallback)
End Function

Function getAllItemsCallback(error, data)
If error Then
If data = undefined Then data = {message: "Network Error"}
MsgBox data.message
Else
Print False
For Each key in data
console.log(key, data[key])
k = [key, key][0]
Print k & ": " & data[key].toString()
Next
End If
End Function
</syntaxhighlight>

== appStorage.removeItem ==

This call removes the item with a specified key. It is available in the Dashboard only.

The syntax of the function is:

'''appStorage.removeItem'''(''key'', ''callback'')

* ''key'' - The name of the item. String.
* ''callback'' - function(''error'', ''data''), required. The function in your app to call when the function is complete (or fails).

<syntaxhighlight lang="JavaScript">
butRemoveItem.onclick = function() {
appStorage.removeItem("SimpleString", done);
};

function done(error, data) {
if (error) {
if (data == undefined) {
data = {
message: "Network Error"
};
}
NSB.MsgBox(data.message);
} else {
console.log("success");
}
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
Function butRemoveItem_onclick()
appStorage.removeItem("SimpleString", done)
End Function

Function done(error, data)
If error Then
If data = undefined Then data = {message: "Network Error"}
MsgBox data.message
Else
console.log("success")
End If
End Function
</syntaxhighlight>

== appStorage.setItem ==

This call adds a key, value pair to appStorage. It is available in the Dashboard only.

The syntax of the function is:

'''appStorage.setItem'''(''key'', *value*, ''callback'')

* ''key'' - The name of the item. String.
* *value* - The name of the item. Can be string, number, array, object: any JavaScript data type.
* ''callback'' - function(''error'', ''data''), required. The function in your app to call when the function is complete (or fails).

<syntaxhighlight lang="JavaScript">
butSetItem.onclick = function() {
appStorage.setItem("SimpleString", "ABCD", done);
appStorage.setItem("Number", 123, done);
appStorage.setItem("Array", [1, 2, 3, 4], done);
appStorage.setItem("Object", {
firstName: "Eric",
lastName: "Cartman"
}, done);
};

function done(error, data) {
if (error) {
if (data == undefined) {
data = {
message: "Network Error"
};
}
NSB.MsgBox(data.message);
} else {
console.log("success");
}
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
Function butSetItem_onclick()
appStorage.setItem("SimpleString", "ABCD", done)
appStorage.setItem("Number", 123, done)
appStorage.setItem("Array", [1, 2, 3, 4], done)
appStorage.setItem("Object", {firstName: "Eric", lastName: "Cartman"}, done)
End Function

Function done(error, data)
If error Then
If data = undefined Then data = {message: "Network Error"}
MsgBox data.message
Else
console.log("success")
End If
End Function
</syntaxhighlight>

== Reference ==

* JavaScript API: [https://docs.voltcloud.io/client/$volt.storage.html https://docs.voltcloud.io/client/$volt.storage.html]
* REST API: [https://docs.voltcloud.io/api/#storage-plug-in https://docs.voltcloud.io/api/#storage-plug-in]

Send email

2017-05-26T23:44:36Z

Sarah: Instructions for sending email to currently signed on user

Volt lets you send email messages to the currently signed on user, much like the 'Confirm Password' email. To do this, you first have to set some things up.

== Email Plugin Settings ==

# Open a [http://sendgrid.com/ SendGrid] account (It's free for low volumes).
# In SendGrid settings, choose API Keys.
# In API Keys, click on Create API Key (general). The only setting needed is to choose "Full Access" for Mail Send.
# When you click Save, you will get a long API key. Save this value.
# Open your app in the [https://dashboard.voltcloud.io/ Volt Dashboard].
# For Email From, enter the email address you want to show as the From address. It can be anything.
# For Email API, enter the long API key from Step 4.
# Save.

[[File:Sending-email.png]]

== Sending Email ==

Now you can send an email to to currently logged in user of your app using the $volt.email.send() function.

The syntax of the function is:

'''$volt.email.send'''(''subject'', ''text'', ''callback'')

* ''subject'' - string, required. The text to appear as the Subject of the email.
* ''text'' - string, required. The text to appear as the Body of the email.
* ''callback'' - function(error, data), required. The function in your app to call when the request to Volt is complete (or fails).

<syntaxhighlight lang="JavaScript">
butSendEmail.onclick = function() {
var subject = 'Email from ' + AppTitle;
var text = 'This message was sent from a Volt app to the currently signed on user.';
$volt.email.send(subject, text, sendEmailCallback);
};

function sendEmailCallback(error, data) {
if (error) {
if (!data) {
data = { message: 'Network Error' };
}
alert(data.message);
} else {
alert('Email Sent.');
}
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
Function butSendEmail_onclick()
Dim subject = "Email from " & AppTitle
Dim text = "This message was sent from a Volt app to the currently signed on user."
setBusyIcon(this)
$volt.email.send(subject, text, sendEmailCallback)
End Function

Function sendEmailCallback(error, data)
clearBusyIcon(this)
If error Then
If (!data) Then data = { message: "Network Error" }
MsgBox data.message
Else
MsgBox "Email Sent."
End If
End Function
</syntaxhighlight>

== Reference ==

* JavaScript API: [https://docs.voltcloud.io/client/$volt.email.html#.send https://docs.voltcloud.io/client/$volt.email.html#.send]
* REST API: [https://docs.voltcloud.io/api/#email-plug-in-email-endpoint-post https://docs.voltcloud.io/api/#email-plug-in-email-endpoint-post]

Current user

2017-05-26T23:23:23Z

Sarah: Instructions for creating and working with the current user

Here are some functions for managing the users of your app. You'll need to [[first_app|initialize your app]], after which you can get the information for the logged in user, modify it or delete it.

== Get User information ==

You can get information on the currently logged on user with the <code>$volt.user.get()</code> function.

The syntax of the function is:

'''$volt.use.get'''(''callback'')

* ''callback'' - function(error, data), required. The function in your app to call when the request to Volt is complete (or fails).

<syntaxhighlight lang="JavaScript">
var user;

butGetUser.onclick = function() {
$volt.user.get(getUserCallback);
}

function getUserCallback(error, data) {
if (error) {
if (!data) {
data = { message: 'Network Error' };
}
alert(data.message);
user = null;
} else {
user = data;
}
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
Dim user

Function butGetUser_onclick()
$volt.user.get(getUserCallback)
End Function

Function getUserCallback(error, data)
If error Then
If (!data) Then data = { message: "Network Error" }
alert(data.message)
user = null
Else
user = data
End If
End Function
</syntaxhighlight>

What gets returned? Here is what is in the initial release of Volt:

<syntaxhighlight lang="json">
{
"id": "7PQipR",
"email": "support@nsbasic.com",
"confirmed": true,
"first_name": "John",
"last_name": "Smith"
}
</syntaxhighlight>

== Modify User information ==

You can change information for the currently logged on user with the <code>$volt.user.update()</code> function.

The syntax of the function is:

'''$volt.user.get'''(''data'', ''callback'')

* ''data'' - object, required. An object with the user details to update.
* ''callback'' - function(error, data), required. The function in your app to call when the request to Volt is complete (or fails).

The data object should be of the following form:

<syntaxhighlight lang="json">
{
"email": "new@email.com",
"password": {
"old": "myOldPassword",
"new": "myNewPassword",
"confirmation": "myNewPassword"
},
"first_name": "Alan",
"last_name": "Turing"
}
</syntaxhighlight>

You can pass <code>email</code>, <code>password</code>, <code>first_name</code>, <code>last_name</code> or any combination thereof. Here's an example of changing the logged in user's email:

<syntaxhighlight lang="JavaScript">
butUpdateUser.onclick = function() {
$volt.user.update({ email: inpNewEmail.value }, updateUserCallback);
}

function updateUserCallback(error, data) {
if (error) {
if (!data) {
data = { message: 'Network Error' };
}
alert(data.message);
} else {
alert('User updated.');
}
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
Function butUpdateUser_onclick()
$volt.user.update({ email: inpNewEmail.value }, updateUserCallback)
End Function

Function getUserCallback(error, data)
If error Then
If (!data) Then data = { message: "Network Error" }
alert(data.message)
Else
alert("User updated.")
End If
End Function
</syntaxhighlight>

== Delete a User ==

You can provide your users with a way to close/delete their accounts using the <code>$volt.user.delete()</code> function.

The syntax of the function is:

'''$volt.user.delete'''(''callback'')

* ''callback'' - function(error, data), required. The function in your app to call when the request to Volt is complete (or fails).

<syntaxhighlight lang="JavaScript">
function deleteUser() {
$volt.user.delete(deleteUserCallback);
}

function deleteUserCallback(error, data) {
if (error) {
if (!data) {
data = { message: 'Network Error' };
}
alert(data.message);
} else {
alert('User deleted.');
}
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
Function deleteUser()
$volt.user.delete(deleteUserCallback)
End Function

Function deleteUserCallback(error, data)
If error Then
If (!data) Then data = { message: "Network Error" }
MsgBox data.message
Else
MsgBox "User Deleted"
End If
End Function
</syntaxhighlight>

== Reference ==

* JavaScript API
* [https://docs.voltcloud.io/client/$volt.user.html#.get https://docs.voltcloud.io/client/$volt.user.html#.get]
* [https://docs.voltcloud.io/client/$volt.user.html#.update https://docs.voltcloud.io/client/$volt.user.html#.update]
* [https://docs.voltcloud.io/client/$volt.user.html#.delete https://docs.voltcloud.io/client/$volt.user.html#.delete]
* REST API
* [https://docs.voltcloud.io/api/#users-current-user-get https://docs.voltcloud.io/api/#users-current-user-get]
* [https://docs.voltcloud.io/api/#users-current-user-put https://docs.voltcloud.io/api/#users-current-user-put]
* [https://docs.voltcloud.io/api/#users-current-user-delete https://docs.voltcloud.io/api/#users-current-user-delete]

User confirmation

2017-05-26T23:08:10Z

Sarah: Instructions for creating user confirmations

Volt allows you to require your users to confirm their accounts via email. By default this is turned off. You can turn it on by setting the confirmation URL in the Dashboard.

== Setting up the Dashboard ==

In the Dashboard, you can set the page in your app that handles user confirmations. The special value <nowiki>{{token}}</nowiki> is replaced by an actual confirmation token that your app can use to reset the password.

[[File:User-confirmation.png]]

The sample string shown is a reasonable one:

* <nowiki>/#</nowiki> - indicates you want to go to a page (form) in your app.
* <nowiki>/confirm</nowiki> - specifically, the confirmation form.
* <nowiki>{{token}}</nowiki> - substitute the reset token here. This will be passed back to Volt later to confirm the reset.

== Confirming the user ==

Once your user registers, Volt will send a confirmation email to make sure he is a legitimate user.

Here's an email similar to what Volt will send to your user. If the link is clicked on, your app will open. Confirmations expire after 12 hours.

Thanks for signing up! Please click the link below to confirm your account:

https://signon.volt.live/#/confirm/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0NzUxNjE3OTcsImV4cCI6MTQ3NTIwNDk5NywiYXVkIjoiL2FwaS9hdXRoL2NvbmZpcm0iLCJpc3MiOiJzaWdub24udm9sdC5saXZlIiwic3ViIjoiN2J2aTR6In0.EkJz1uL3Uo59PPa24bQN2ctXZY4LRwiAVH00kvFpNN0

If you didn't sign up for an account, you can ignore this message.

The complete string will be in <code>location.hash</code> in your app.

Once the user clicks on the URL in the email, your app can send the confirmation to Volt using the <code>$volt.auth.confirm()</code> function.

The syntax of the function is:

'''$volt.auth.confirm'''(''token'', ''callback'')

* ''token'' - string, required. The token in the URL.
* ''callback'' - function(error, data), required. The function in your app to call when the request to Volt is complete (or fails).

<syntaxhighlight lang="JavaScript">
function confirm() {
var queryParams = location.hash.split('/');

$volt.auth.confirm(queryParams[2], confirmCallback);
}

function confirmCallback(error, data) {
if (error) {
if (!data) {
data = { message: 'Network Error' };
}
alert(data.message);
} else {
alert('Your account is confirmed. Have a nice day!');
}
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
Function confirm()
Dim queryParams
queryParams = location.hash.split("/")

$volt.auth.confirm(queryParams[2], confirmCallback);
End Function

Function confirmCallback(error, data)
If error Then
If (!data) Then data = { message: "Network Error" }
MsgBox data.message
Else
MsgBox "Your account is confirmed. Have a nice day!"
End If
End Function
</syntaxhighlight>

== Resending Confirmations ==

Occasionally an account confirmation may not be delivered due to the nature of email. Additionally account confirmations expire after 12 hours. In these cases, you can provide your users with the capability to resend an account confirmation using the <code>$volt.auth.resend()</code> function.

The syntax of the function is:

'''$volt.auth.resend'''(''email'', ''appId'', ''callback'')

* ''email'' - string, required. The email to resend the confirmation to.
* ''appId'' - string, optional. The Volt ID of the app to sign into. If not supplied, defaults to value set in <code>$volt.init(appId)</code>.
* ''callback'' - function(error, data), required. The function in your app to call when the request to Volt is complete (or fails).

<syntaxhighlight lang="JavaScript">
butResendConfirmation.onclick = function () {
$volt.auth.resend(inpEmail.value, butResendConfirmationCallback);
}

function butResendConfirmationCallback(error, data) {
if (error) {
if (!data) {
data = { message: 'Network Error' };
}
alert(data.message);
} else {
alert('An email is on its way to you.');
}
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
Function butResendConfirmation_onclick()
$volt.auth.forgot(inpEmail.value, butResendConfirmationCallback)
End Function

Function butResendConfirmationCallback(error, data)
If (error) Then
If (!data) Then data = { message: "Network Error" }
MsgBox data.message
Else
MsgBox "An email is on its way to you."
End If
End Function
</syntaxhighlight>

== Reference ==

* JavaScript API
** [https://docs.voltcloud.io/client/$volt.auth.html#.confirm https://docs.voltcloud.io/client/$volt.auth.html#.confirm]
** [https://docs.voltcloud.io/client/$volt.auth.html#.resend https://docs.voltcloud.io/client/$volt.auth.html#.resend]
* REST API
** [https://docs.voltcloud.io/api/#authentication-confirm-account-post https://docs.voltcloud.io/api/#authentication-confirm-account-post]
** [https://docs.voltcloud.io/api/#authentication-resend-confirmation-post https://docs.voltcloud.io/api/#authentication-resend-confirmation-post]

Resetting passwords

2017-05-26T22:54:08Z

Sarah: Instructions for resetting passwords

Sometimes your users will forget their passwords. Other times, their passwords may need to be reset. Volt has functions to help you deal with this.

First, let's review what happens when a user forgets a password:
# In the login form, if the user can't remember the password, "Forget Password" is clicked.
# This sends a message to Volt to start the reset process.
# Volt sends an email to the user with a link to reset the password.
# The link is under your control: it's set in the Dashboard.
# The link opens your app to its password reset form.
# The new password information is sent to Volt to update the user's data.

The capability to reset passwords is disabled by default. You can enable it by setting your app's Reset URL in the Dashbaord.

== Setting up the Dashboard ==

In the Dashboard, you can set the page in your app that handles user password resets. The special value <nowiki>{{token}}</nowiki> is replaced by an actual confirmation token that your app can use to reset the password. Confirmation tokens expire one hour after sending.

[[File:Resetting-passwords-reset.png]]

The sample string shown is a reasonable one:

* <nowiki>/#</nowiki> - indicates you want to go to a page (form) in your app.
* <nowiki>/reset</nowiki> - specifically, the reset form.
* <nowiki>{{token}}</nowiki> - substitute the reset token here. This will be passed back to Volt later to authenticate the reset.

== Forgotten Passwords ==

To ask Volt to reset a forgotten password, you can call the <code>$volt.auth.forgot()</code> function to start the process.

The syntax of the function is:

'''$volt.auth.forgot'''(''email'', ''appId'', ''callback'')

* ''email'' - string, required. The email address of the user.
* ''appId'' - string, optional. The Volt ID of the app to sign into. If not supplied, defaults to value set in <code>$volt.init(appId)</code>.
* ''callback'' - function(error, data), required. The function in your app to call when the request to Volt is complete (or fails).

<syntaxhighlight lang="JavaScript">
butSendResetPassword.onclick = function () {
$volt.auth.forgot(inpEmail.value, butSendResetPasswordCallback);
}

function butSendResetPasswordCallback(error, data) {
if (error) {
if (!data) {
data = { message: 'Network Error' };
}
alert(data.message);
} else {
alert('An email is on its way to you.');
}
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
Function butSendResetPassword_onclick()
$volt.auth.forgot(inpEmail.value, butSendResetPasswordCallback)
End Function

Function butSendResetPasswordCallback(error, data)
If (error) Then
If (!data) Then data = { message: "Network Error" }
MsgBox data.message
Else
MsgBox "An email is on its way to you."
End If
End Function
</syntaxhighlight>

== Resetting Passwords ==

Here's an email similar to what Volt will send to your user. If the link is clicked on, your app will open. Password resets expire after one hour.

Click the link below to reset your password:

https://project1.voltcloud.io/#/reset/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0NzUxMDUyMDgsImV4cCI6MTQ3NTEwODgwOCwiYXVkIjoiL2FwaS9hdXRoL3Jlc2V0IiwiaXNzIjoiZGFzaGJvYXJkLnZvbHRjbG91ZC5pbyIsInN1YiI6IjdQUWlwUiJ9.MVv2wK3WtB9NF2QlFfPlG2GYgy9T7UtJD9jqEWrCj0U

If you didn't request a password reset, you can ignore this message.

The complete string will be in <code>location.hash</code> in your app. You'll want to show a form which looks something like this:

[[File:Resetting-passwords-form.png]]

Once the user has filled in the new password and confirmation, you can send it to Volt using the <code>$volt.auth.reset()</code> function.

The syntax of the function is:

'''$volt.auth.reset'''(''token'', ''password'', ''confirmation'', ''callback'')

* ''token'' - string, required. The token in the URL.
* ''password'' - string, required. The new password.
* ''confirmation'' - string, required. The confirmation password. Should be the same.
* ''callback'' - function(error, data), required. The function in your app to call when the request to Volt is complete (or fails).

<syntaxhighlight lang="JavaScript">
butResetPassword.onclick = function () {
var queryParams = location.hash.split('/');

$volt.auth.reset(queryParams[2], inpPasswordNew.value, inpPasswordConfirm.value, resetPasswordCallback);
}

function resetPasswordCallback(error, data) {
if (error) {
if (!data) {
data = { message: 'Network Error' };
}
alert(data.message);
} else {
alert('Password Updated.');
}
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
Function butResetPassword_onclick()
Dim queryParams
queryParams = location.hash.split("/")

$volt.auth.reset(queryParams[2], inpPasswordNew.value, inpPasswordConfirm.value, resetPasswordCallback);
End Function

Function resetPasswordCallback(error, data)
If error Then
If (!data) Then data = { message: "Network Error" }
MsgBox data.message
Else
MsgBox "Password Updated."
End If
End Function
</syntaxhighlight>

== AppStudio Users ==

[https://www.nsbasic.com/ AppStudio] includes a form called frmSignOn. If you include it in your app, forgot is built in. For resets, do the following:

<syntaxhighlight lang="JavaScript">
var queryParams = location.hash.split('/');

function Main() {
if ((queryParams.length > 1)) {
if (queryParams[1] == 'reset') {
showResetPassword();
}
}
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
Dim queryParams
queryParams = location.hash.split("/")

Sub Main()
If (queryParams.length > 1) Then
If queryParams[1] = "reset" Then
showResetPassword()
End If
End If
End Sub
</syntaxhighlight>

== Reference ==

* JavaScript API
** [https://docs.voltcloud.io/client/$volt.auth.html#.forgot https://docs.voltcloud.io/client/$volt.auth.html#.forgot]
** [https://docs.voltcloud.io/client/$volt.auth.html#.reset https://docs.voltcloud.io/client/$volt.auth.html#.reset]
* REST API
** [https://docs.voltcloud.io/api/#authentication-forgot-password-post https://docs.voltcloud.io/api/#authentication-forgot-password-post]
** [https://docs.voltcloud.io/api/#authentication-reset-password-post https://docs.voltcloud.io/api/#authentication-reset-password-post]

User registration

2017-05-26T22:33:23Z

Sarah: Instructions for registering users

To sign a user up for your app, you'll need to get an email address and a password from them and send it to Volt. If enabled, Volt will send a [[user_confirmation|confirmation]] email. Once the user registers, they will be able to [[log_in|sign on to your app]].

== Registering a User ==

Here's a typical user registration screen:

[[File:Registering-a-user.png]]

Once you've collected the data, you can call Volt using <code>$volt.auth.register()</code> function to register. This will create an account.

The syntax of the function is:

'''$volt.auth.register'''(''email'', ''password'', ''confirmation'', ''appId'', ''callback'')

* ''email'' - string, required. The email address of the user.
* ''password'' - string, required. The user's password.
* ''confirmation'' - string, required. The confirmation password. Must match.
* ''appId'' - string, optional. The Volt ID of the app to sign into. If not supplied, defaults to value set in <code>$volt.init(appId)</code>.
* ''callback'' - function(error, data), required. The function in your app to call when the register is complete (or fails).

After Volt receives the registration, it will send a [[user_confirmation|confirmation email]] if you have enabled that functionality.

<syntaxhighlight lang="JavaScript">
butCreateAccount.onclick = function () {
$volt.auth.register(inpEmail.value, inpPassword.value, inpPasswordConfirm.value, createAccountCallback);
}

function createAccountCallback(error, data) {
if (error) {
if (!data) {
data = { message: 'Network Error' };
}
alert(data.message);
} else {
alert('Your account has been registered.');
}
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
Function butCreateAccount_onclick()
$volt.auth.register(inpEmail.value, inpPassword.value, inpPasswordConfirm.value, createAccountCallback)
End Function

Function createAccountCallback(error, data) {
If error Then
If (!data) Then data = { message: "Network Error" }
MsgBox data.message
Else
MsgBox "Your account has been registered."
End If
End Function
</syntaxhighlight>

== AppStudio Users ==

[https://www.nsbasic.com/ AppStudio] includes a form called frmSignOn. If you include it in your app, a register form is included. To use it, do the following:

<syntaxhighlight lang="JavaScript">
showCreateAccount();
</syntaxhighlight>

<syntaxhighlight lang="basic">
showCreateAccount()
</syntaxhighlight>

== Reference ==

* JavaScript API: [https://docs.voltcloud.io/client/$volt.auth.html#.register https://docs.voltcloud.io/client/$volt.auth.html#.register]
* REST API: [https://docs.voltcloud.io/api/#authentication-register-post https://docs.voltcloud.io/api/#authentication-register-post]

Manage apps

2017-05-26T22:21:07Z

Sarah: Instructions for managing apps

Volt supplies a [https://dashboard.voltcloud.io/ Dashboard] to help manage your apps. Once you sign in, you will see a list of your apps. You can then perform a variety of tasks, including renaming, deleting and managing users.

== Your Apps ==

Here is what you see when you log into the Dashboard:

[[File:Managing-your-apps-overview.png]]

'''Your Apps''' shows a summary of your apps. Clicking on the name of the app will open '''App Information''' for that app. Clicking the URL will open the app and run it in your browser. You can also scan the QR code on your device to open the app - it's much quicker than entering a URL on a mobile device keyboard.

== App Information ==

[[File:Managing-your-apps-detail.png]]

The '''App Information'' shows, and allows your to edit, the information about your app.

=== Details ===

Here's what the fields are:

'''Name''' - The name of the app. It's initially set up to be appname-randomWord-randomWord, so it will be unique. You can change it to whatever you like as long as that name isn’t already taken by another user. It must start with a letter or number and can only contain lowercase letters, numbers, and dashes.

'''ID''' - The unique ID assigned to this app by Volt. It cannot be edited. If you're using AppStudio, you will see this value in Volt AppID in Project Properties after your project has been uploaded to Volt.

'''Upload''' - The date of the most recent upload. It cannot be edited.

'''URL''' - The URL of the app on the AppStudio server. Click on it to load and run the app. If you change the '''Name''', the URL will change.

'''Confirm Page''' - The page in your app that handles user confirmation. The special value <nowiki>{{token}}</nowiki> is replaced by an actual confirmation token that your app can use to confirm the account. Learn more about [[user_confirmation|user confirmations]].

'''Reset Page''' - The page in your app that handles user password resets. The special value <nowiki>{{token}}</nowiki> is replaced by an actual confirmation token that your app can use to reset the password. Learn more about [[resetting_passwords|resetting passwords]].

'''Framing''' - Controls if the app can be framed by another site. Can be set to none, self, any, or domain. If set to none (the default) then framing is not allowed. If set to self, then the app can only frame itself. If set to any then any site can frame the app (this is not recommended). If set to domain then only the URL which is specified will be allowed to frame the site.

'''CORS''' - Controls if the app's API allows incoming requests from other domains (CORS). cors_type can be set to none, any, or domain. If set to none (the default), then no cross domain requests are allowed. If set to any, requests from any domain are allowed (this is not recommended). If set to domain, requests will be allowed only from specified URL.

'''Nice Links''' - If set, the server will redirect links that aren't found to index.html, allowing a client side router to service any links. No # character will appear in the URL. For AppStudio users, be sure to set NiceLinks in [[Properties_Window|Project Properties]] to true as well.

=== Actions ===

'''Users''' - Opens the [[manage_users|Users]] screen. Use it to see the list of your users for the app, and to delete them.

'''Delete''' - Delete the app. All users must be deleted first. This action CANNOT be undone. It will permanently delete the app and all of its storage.

Log in

2017-05-26T22:04:43Z

Sarah: Instructions for logging in and out

After you've [[First_app|initialized]], you can use Volt to control who is allowed to use your app. Only users who have registered will be able to log into your app.

== Checking if user is logged in ==

Use the <code>$volt.auth.isLoggedIn()</code> to check if a user is logged in:

<syntaxhighlight lang="JavaScript">
if ($volt.auth.isLoggedIn()) {
// Ok to do processing
} else {
// ask user to log in
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
If $volt.auth.isLoggedIn() Then
'Ok to do processing
Else
'ask user to log in
End If
</syntaxhighlight>

== Logging In ==

Logging in identifies your user to the Volt server. Here is a typical log in screen:

[[File:Logging-in-and-out.png]]

Once you have have obtained the user's email and password (either from a screen like the above or otherwise), you can call the <code>$volt.auth.login()</code> function to log the user in.

The syntax of the function is:

'''$volt.auth.login'''(''email'', ''password'', ''appId'', ''callback'')

* ''email'' - string, required. The email address of the user.
* ''password'' - string, required. The user's password.
* ''appId'' - string, optional. The Volt ID of the app to sign into. If not supplied, defaults to value set in <code>$volt.init(appId)</code>.
* ''callback'' - function(error, data), required. The function in your app to call when the login is complete (or fails).

<syntaxhighlight lang="JavaScript">
butSignOn.onclick = function () {
$volt.auth.login(inpEmail.value, inpPassword.value, signOnCallback);
}

function signOnCallback(error, data) {
if (error) {
if (!data) {
data = { message: 'Network Error' };
}
alert(data.message);
} else {
alert('User successfully logged in');
}
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
Sub butSignOn.onclick()
$volt.auth.login(inpEmail.value, inpPassword.value, signOnCallback);
End Sub

Function signOnCallback(error, data)
If error Then
If (!data) Then data = { message: "Network Error" }
MsgBox data.message
Else
MsgBox "User successfully logged in"
End If
End Sub
</syntaxhighlight>

== Logging Out ==

You can log your user out by using <code>$volt.auth.logout()</code>:

<syntaxhighlight lang="JavaScript">
$volt.auth.logout();
</syntaxhighlight>

<syntaxhighlight lang="basic">
$volt.auth.logout()
</syntaxhighlight>

== AppStudio Users ==

[https://www.nsbasic.com/ AppStudio] includes a form for handling login duties, called frmSignOn. If you include it in your app, you can call it as follows:

<syntaxhighlight lang="JavaScript">
butSignIn.onclick = function() {
showSignIn(signInCallback);
};

function signInCallback() {
butSignIn.disabled = true;
NSB.MsgBox('SignIn successful.');
}
</syntaxhighlight>

<syntaxhighlight lang="basic">
Function butSignIn_onclick()
showSignIn(signInCallback)
End Function

Function signInCallback()
butSignIn.disabled = True
MsgBox "SignIn successful."
End Function
</syntaxhighlight>

== Reference ==

* JavaScript API
** [[https://docs.voltcloud.io/client/$volt.auth.html#.isLoggedIn https://docs.voltcloud.io/client/$volt.auth.html#.isLoggedIn]]
** [[https://docs.voltcloud.io/client/$volt.auth.html#.login https://docs.voltcloud.io/client/$volt.auth.html#.login]]
** [[https://docs.voltcloud.io/client/$volt.auth.html#.logout https://docs.voltcloud.io/client/$volt.auth.html#.logout]]
* REST API: [[https://docs.voltcloud.io/api/#authentication-login-post https://docs.voltcloud.io/api/#authentication-login-post]]

Volt for appstudio

2017-05-26T21:49:15Z

Sarah: Information and instructions for AppStudio users for using Volt

== Introduction ==

[https://www.voltcloud.io Volt] is a cloud service which provides additional functionality for AppStudio. It's designed as a platform, so new features can be added.

Volt replaces the AppStudio Server, and does much more! Initial features include:

* App Hosting: Upload your apps to Volt and they can be accessed by users anywhere in the world. Permanent hosting is available.
* Custom Domains: Use custom domains you own for your apps, or use domains assigned by Volt.
* App Management: Display and configure your apps on the Volt server using your [https://dashboard.voltcloud.io Dashboard].
* User Management: Allow your users to sign into your app with usernames and passwords.

== AppStudio Demo Users ==

If you're using the AppStudio Demo, you don't need to create an account to use Volt. When you deploy, your app will be placed on the Volt server, and you will be given a link to access it. It will remain on the server for an hour.

Once you sign up for AppStudio, you can create a Volt account and use all the Volt services.

== AppStudio Registered Users ==

If you are a licensed AppStudio user, Volt replaces the AppStudio Server you previously used. Deploy works the same way. We encourage you to get your free Volt account because it will help you manage your apps.

If you do not want to use any of the additional features (such as Users, Email, etc.) don't worry about them. There is no need to know more at this point.

== Managing Your Own Account ==

If you don't have an account, you will still be able to deploy apps. They will be available for about an hour. If you want to apps to remain longer or use Volt features, you will need to sign up.

To sign up, go into the Volt tab in AppStudio Preferences and click on "Sign up for Volt". Follow the instructions and a free Volt account will be set up for you. Once this is done, enter the email and password for your account into AppStudio's Volt Preferences tab.

== Using Volt from AppStudio ==

There are several places which AppStudio interacts with Volt.

=== The Run Menu ===

[[File:Volt-for-appstudio-users-runmenu.png]]

* Deploy to Volt: This uploads your app to the Volt server. If you have an account, it should be entered into Preferences. If you do not, the app will only remain on the server for an hour.
* Manage your Volt App: This opens the Volt Dashboard to your currently loaded app and lets you customize its features.
* Sign In/Sign Up to Volt: This opens the Volt Dashboard and lets you sign in to manage your apps. If you do not have an account, you can sign up for one here.

== Volt Preferences ==

In Preferences. Use this panel to enter your Volt email and password. This will let AppStudio sign you on directly when you deploy.

[[File:Volt-for-appstudio-users-voltprefs.png]]

== The Dashboard - Your Apps ==

The Dashboard is an app for managing your Volt apps. You can get to it by going to [https://dashboard.voltcloud.io/ https://dashboard.voltcloud.io/]. Here's the main screen:

[[File:Volt-for-appstudio-users-dashboard.png]]

* Open will run the App
* Clicking on one of the items will open the App Details

== The Dashboard - App Information ==

[[File:Volt-for-appstudio-users-appdetails.png]]

* On that same page, there are actions you can perform on your app:

[[File:Volt-for-appstudio-users-appactions.png]]

* Delete removes your app from Volt.
* Users let your view and remove users of that app.

== The Dashboard - Users ==

[[File:Volt-for-appstudio-users-appusers.png]]

== Managing your App's User Accounts ==

Volt lets you manage a list of users who are allowed to access your app. It handles signing up, signing in, signing out and all the other functions which are needed (email confirmations, forgot passwords, etc...).

When you sign up for a Volt account, you're using the same mechanism. You will find samples in BASIC and JavaScript in the AppStudio Samples, in a new folder called Volt. You're welcome to adapt these samples into your own apps.

== Email ==

Coming soon.

== Samples ==

Samples for using Volt features in AppStudio are included with the normal AppStudio samples, under "4 Volt Services". To use these samples, deploy them to Volt. They will not work in your local browser.

Manage users

2017-05-26T21:33:55Z

Sarah: Instructions on managing app users.

Volt supplies a [https://dashboard.voltcloud.io/ Dashboard] to help manage your apps. One of its features is that you can use it to manage the users who have signed up for the app.

== Users ==

Here is what you see when you log into the Dashboard, choose an app and click on the Users button:

[[File:Managing-your-users.png]]

Each of your users is shown, whether they are confirmed or not.

To delete a user, click on the Delete button. All information about the user will be permanently removed. The user will have to sign up again to use your app.

'''Delete All Users''' will delete all the users of your app. Use this very carefully!

File:Volt-for-appstudio-users-appactions.png

2017-05-26T21:28:53Z

Sarah:

File:Volt-for-appstudio-users-appdetails.png

2017-05-26T21:28:33Z

Sarah:

File:Volt-for-appstudio-users-appusers.png

2017-05-26T21:28:04Z

Sarah:

File:Volt-for-appstudio-users-dashboard.png

2017-05-26T21:27:44Z

Sarah:

File:Volt-for-appstudio-users-runmenu.png

2017-05-26T21:27:22Z

Sarah:

File:Volt-for-appstudio-users-voltprefs.png

2017-05-26T21:26:45Z

Sarah:

File:Logging-in-and-out.png

2017-05-26T21:26:20Z

Sarah:

File:Managing-your-apps-overview.png

2017-05-26T21:24:46Z

Sarah:

File:Managing-your-users.png

2017-05-26T21:23:39Z

Sarah:

File:Registering-a-user.png

2017-05-26T21:22:55Z

Sarah: Screenshot of the user registration form.

Screenshot of the user registration form.

File:Resetting-passwords-form.png

2017-05-26T21:21:55Z

Sarah: Screenshot of the reset password form

Screenshot of the reset password form

File:Resetting-passwords-reset.png

2017-05-26T21:21:11Z

Sarah:

File:User-confirmation.png

2017-05-26T21:20:29Z

Sarah: Screenshot of confirm page input

Screenshot of confirm page input

File:Sending-email.png

2017-05-26T21:19:00Z

Sarah: Screenshot of the email plugin form.

Screenshot of the email plugin form.

File:Managing-your-apps-detail.png

2017-05-26T21:17:52Z

Sarah: Detailed image of the App Info form on the Volt Dashboard.

Detailed image of the App Info form on the Volt Dashboard.

Error handling

2017-05-26T18:12:34Z

Sarah: Instructions on handling various types of errors.

As much as we'd like to avoid errors, they happen from time to time. When making asynchronous calls using Volt's [https://docs.voltcloud.io/client/ client library] the callbacks are always of the form: <code>callback(error, data)</code>. If <code>error</code> is [https://developer.mozilla.org/en-US/docs/Glossary/Truthy truthy] it means an error has occurred while making your request. Here are some tips for understanding exactly what has gone wrong.

== The Error Object ==

We'll start by taking a look at the <code>error</code> parameter of the callback. If an error has occurred, it will be a standard [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error JavaScript Error] object.

The <code>error</code> parameter is always guaranteed to have a <code>message</code> attribute. In the case of network timeouts and errors, this will be the only attribute set. You might consider using an alert to display this message to the user:

<syntaxhighlight lang="JavaScript">
$volt.user.get(function (error, data) {
if (error) {
alert(error.message);
} else {
alert('Success!');
}
});
</syntaxhighlight>

<syntaxhighlight lang="basic">
Function userCallback(error, data)
If error Then
alert(error.message)
Else
alert("Success!")
End If
End Function

$volt.user.get(userCallback)
</syntaxhighlight>

If the [https://docs.voltcloud.io/api/ Volt API] is reachable and responds with an error, an additional parameter is added to the error object: <code>status</code>. If <code>error.status</code> is defined, it will be set to the HTTP status code returned by the API. This value can be useful for debugging or logging.

== The Data Object ==

For nearly all API errors, Volt returns an additional data object that gives you more specific information about what has caused the error. At a minimum that object will be of this form:

<syntaxhighlight lang="json">
{
"type": "VoltError",
"message": "Detailed description of the error."
}
</syntaxhighlight>

Generally <code>data.message</code> can be useful to display to an end user whereas <code>data.type</code> is useful for debugging or logging. We can modify our code above to display <code>data.message</code> if it's available:

<syntaxhighlight lang="JavaScript">
$volt.user.get(function (error, data) {
if (error) {
if (data) {
alert(data.message);
} else {
alert(error.message);
}
} else {
alert('Success!');
}
});
</syntaxhighlight>

<syntaxhighlight lang="basic">
Function userCallback(error, data)
If error Then
If data Then
alert(data.message)
Else
alert(error.message)
End If
Else
alert("Success!")
End If
End Function

$volt.user.get(userCallback)
</syntaxhighlight>

== Extended Error Data ==

Certain types of Volt errors include additional information in their data object.

=== ValidationError ===

A <code>ValidationError</code> occurs when the data you've passed in your request is invalid in some way. It may include an additional attribute: <code>validations</code>. If <code>validations</code> it truthy, it will be either in the form of a general validation, or a password validation.

==== General Validation Errors ====

For general validation errors, <code>error.validations.body</code> will be an object of the following form:

<syntaxhighlight lang="json">
{
"body": [
{
"value": "notanemail",
"property": "request.body.email",
"messages": [
"does not conform to the \"email\" format"
]
},
{
"property": "request.body",
"messages": [
"requires property \"password\""
]
}
]
}
</syntaxhighlight>

The above response was generated from the following invalid call: <code>$volt.auth.register('notanemail, undefined, 'does not match', callback);<c/ode>. If <code>error.validations.body</code> exists, it will be an array of objects. Each object will have at a minimum <code>property</code> and <code>messages</code> attributes. Some will also have a <code>value</code> attribute.

* <code>property</code> - the property that failed validation. You can ignore the <code>request.body</code> portion. In the case that the property is exactly equal to <code>request.body</code> it indicates a problem with the entire request.
* <code>messages</code> - an array of messages describing why validation failed.
* <code>value</code> - the value that failed validation, if applicable.

Generally, you will want to perform client side validation and not depend on only server side validation. However, the above data structure can provide valuable insight into why your requests are failing.

==== Password Validation Errors ====

For invalid passwords, <code>error.validations.password</code> is an array of messages indicating which validations were failed by the password:

<syntaxhighlight lang="json">
{
"password": [
"The password must be at least 10 characters long.",
"The password must contain at least one uppercase letter.",
"The password must contain at least one number.",
"The password must contain at least one special character."
]
}
</syntaxhighlight>

=== ConflictError ===

A <code>ConflictError</code> occurs when your request would cause a conflict, for instance if you attempt to register using an email address that's already in use. It includes an additional attribute, <code>conflict</code>, that includes an identifier of the existing object that would be in conflict. This is generally useful for debugging.

=== UnknownClientError ===

It's rare that you'll see an <code>UnknownClientError</code>. It generally means something was wrong with your request to the API. It includes an additional attribute in the data object: <code>detail</code>. This may provide additional detail as to why the error occurred.

First app

2017-05-18T20:20:49Z

Sarah:

Volt is designed to require very little code to get started. Currently, there are two ways to create and upload an app:

# From the "Your Apps" page in the [https://dashboard.voltcloud.io dashboard] click on "+ Add App". Once your App has been created, you can click on the "Upload" button on the "App Information" page. This will prompt you to upload a zip file of your app.
# You can upload any app you create in [[Faq#AppStudio_Users|AppStudio]].

We're working to allow apps to be uploaded and deployed using a wide variety of common tools.

== Initializing ==

Once you've created a new app and obtained your app ID from the Dashboard, you can create your first Volt app. The following example shows the simplest functioning app you could create:

<syntaxhighlight lang="html" highlight="9,10,11,12,13">
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Volt Example</volt>
</head>
<body>
<p>It doesn't get much simpler than this!</p>
<script src="/api/client/volt.min.js"></script>
<script>
var appId = 'abc123';
$volt.init(appId);
</script>
</body>
</html>
</syntaxhighlight>

The highlighted section of this example is the most important. It shows two sets of script tags:

# The first script tag includes the Volt [https://docs.voltcloud.io/client/ client library]. The library will always be available at this location when your app is hosted on the Volt server.
# The second script tag initializes your app. Every app has an ID, and you must initialize volt with your app ID before you can use the client library to make further Volt calls.

== For AppStudio Users ==

AppStudio is tightly integrated with Volt, making it easy to upload, run and manage your apps.

=== Uploading to Volt ===

On the Run menu, choose "Deploy to Volt". Your app will be uploaded to Volt and the URL to run it will be displayed. The Volt AppId will be placed in your [[Properties_Window|Project Properties]].

=== Managing your App ===

If you have subscribed to AppStudio and have entered a Volt password, you can use the Volt [https://dashboard.voltcloud.io/ Dashboard] to [[Manage_apps|manage your apps]].

You can open the Dashboard at [https://dashboard.voltcloud.io/ https://dashboard.voltcloud.io/] or from the AppStudio [[Menu_Options|Run menu]].

=== Managing your Volt Account ===

If you have [https://www.nsbasic.com/i/Subscription/ subscribed] to AppStudio on any of the plans (including the free demo), you're entitled to deploy to Volt from the AppStudio Run menu.

To use the [https://dashboard.voltcloud.io/ Dashboard], you'll need a Volt account. If you have a Starter, Essential or Pro subscription, you're entitled to a free Volt account. Reply to the registration confirmation email by setting up a password and you'll be allowed to use it.

You can also set up a Volt account from the AppStudio Run menu or from [[Preferences|Volt Preferences]].

== Reference ==

* JavaScript API: [https://docs.voltcloud.io/client/$volt.html#.init https://docs.voltcloud.io/client/$volt.html#.init]

First app

2017-05-18T20:19:42Z

Sarah: Tutorial for creating, initializing, and deploying your first Volt app

Volt is designed to require very little code to get started. Currently, there are two ways to create and upload an app:

1. From the "Your Apps" page in the [https://dashboard.voltcloud.io dashboard] click on "+ Add App". Once your App has been created, you can click on the "Upload" button on the "App Information" page. This will prompt you to upload a zip file of your app.
2. You can upload any app you create in [[Faq#AppStudio_Users|AppStudio]].

We're working to allow apps to be uploaded and deployed using a wide variety of common tools.

== Initializing ==

Once you've created a new app and obtained your app ID from the Dashboard, you can create your first Volt app. The following example shows the simplest functioning app you could create:

<syntaxhighlight lang="html" highlight="9,10,11,12,13">
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Volt Example</volt>
</head>
<body>
<p>It doesn't get much simpler than this!</p>
<script src="/api/client/volt.min.js"></script>
<script>
var appId = 'abc123';
$volt.init(appId);
</script>
</body>
</html>
</syntaxhighlight>

The highlighted section of this example is the most important. It shows two sets of script tags:

1. The first script tag includes the Volt [https://docs.voltcloud.io/client/ client library]. The library will always be available at this location when your app is hosted on the Volt server.
2. The second script tag initializes your app. Every app has an ID, and you must initialize volt with your app ID before you can use the client library to make further Volt calls.

== For AppStudio Users ==

AppStudio is tightly integrated with Volt, making it easy to upload, run and manage your apps.

=== Uploading to Volt ===

On the Run menu, choose "Deploy to Volt". Your app will be uploaded to Volt and the URL to run it will be displayed. The Volt AppId will be placed in your [[Properties_Window|Project Properties]].

=== Managing your App ===

If you have subscribed to AppStudio and have entered a Volt password, you can use the Volt [https://dashboard.voltcloud.io/ Dashboard] to [[Manage_apps|manage your apps]].

You can open the Dashboard at [https://dashboard.voltcloud.io/ https://dashboard.voltcloud.io/] or from the AppStudio [[Menu_Options|Run menu]].

=== Managing your Volt Account ===

If you have [https://www.nsbasic.com/i/Subscription/ subscribed] to AppStudio on any of the plans (including the free demo), you're entitled to deploy to Volt from the AppStudio Run menu.

To use the [https://dashboard.voltcloud.io/ Dashboard], you'll need a Volt account. If you have a Starter, Essential or Pro subscription, you're entitled to a free Volt account. Reply to the registration confirmation email by setting up a password and you'll be allowed to use it.

You can also set up a Volt account from the AppStudio Run menu or from [[Preferences|Volt Preferences]].

== Reference ==

* JavaScript API: [https://docs.voltcloud.io/client/$volt.html#.init https://docs.voltcloud.io/client/$volt.html#.init]

Faq

2017-05-18T18:45:27Z

Sarah: /* Does it cost extra to use Volt? */

== General ==

=== What is Volt? ===
Volt is a platform to electrify your web apps! It provides simple hosting and extended services for your web and mobile apps via an easy to use interface to deploy your apps, and custom names using full HTTPS on a fast, stable platform.

Extended services currently include user management and server storage. We would like to offer a steady stream of additional services, and would like to hear from you about what services would make your experience using Volt better! [mailto:support@nsbasic.com Let us know what you're interested in!]

=== How safe is my data? ===

The safety of your data is top priority to us! Your data is backed up by a reliable and redundant on-site solution, and hard drive failures are tolerated by utilizing [https://en.wikipedia.org/wiki/RAID RAID] across many drives.

Additionally, the Volt server is built on industry standard technology - updates and security advisories are installed on a continuous basis.

=== What does it cost to use? ===

There is no initial cost to use Volt. Several tiered service plans will be available depending on your needs, but we expect there will always be a free plan.

=== Can I host my apps on it? ===

Yes. When you deploy your app to Volt, we take care of the rest. No worries about security certificates, MIME type configuration, updating servers or maintaining the server stack.

=== I used to host my web app on Dropbox. Can I use Volt instead? ===

Yes, Volt is designed to be the optimal server for web apps!

Dropbox announced that on Oct 3, 2016, [https://www.dropbox.com/help/files-folders/public-folder they will no longer allow content to display in-browser]. Acting as a web server isn’t what they wanted to do.

=== Can I run PHP on Volt? ===

We are moving away from the use of PHP because it can be tricky, especially for new users, and it's a chore to set up and maintain. Volt is designed to have many of the same features you get using PHP, but in a vastly easier-to-use environment!

=== I need a custom service. Can I talk to you about it? ===

Yes. Drop us a line at [mailto:support@nsbasic.com support@nsbasic.com]. If we think your idea might be useful to other users (and you don’t mind), we’ll even give you a break on the dev costs!

=== Volt calls my app https://mygreatapp.volt.live. Can I use my own URL? ===

This service will be available soon. You will be able to use a URL of your choice (like https://mygreatapp.com), so long as you control the domain.

While some setup will be needed to use this service, the result will be that your apps will look like they originate from your website, but are actually served by Volt.

=== Are there any restrictions on what I can do with Volt? ===

Nearly any legal use is acceptable. You can learn more from our [https://www.nsbasic.com/app/AppStudioTOS.txt terms of service].

=== Who can use it? ===

Initially, just AppStudio users. However, you can [mailto:support@nsbasic.com contact us] to request early access if you're not an AppStudio user. Note that the service is just launching and we're still likely to make changes to it.

== AppStudio Users ==

=== How is this different from the AppStudio Server (nsbapp.com)? ===

The AppStudio Server was designed to help with development, but not permanent hosting. Volt is a permanent hosting solution. It provides all the tools you need to either host your app, or provide a backend for a hybrid app or existing server.

=== Can I continue to use the AppStudio Server? ===

If you are on AppStudio 5 or older, the AppStudio server will continue to work until May 1st, 2017. AppStudio 6 always uses Volt.

=== How do I sign up for Volt? ===

Volt is free with your [https://www.nsbasic.com/i/Subscription/ subscription] to AppStudio 6! By subscribing you’ll receive continual updates to AppStudio, plus access to Volt Essential - our new cloud services platform built from the ground up to work with AppStudio.

If you are using a demo of AppStudio 6, you are able to sign up at our Starter level for free by clicking on the “Run” menu and choosing “Sign-up/Sign-in to Volt”.

=== Why has AppStudio switched to subscription billing? ===

In order to continue providing you with the innovative, high quality product you are used to, AppStudio has transitioned to a subscription billing. This transition will not only allow us to continue making AppStudio more useful to you, but also allow us to provide tight integration with a cloud service provider built from the ground up for AppStudio - namely Volt.

=== Can I use Volt with AppStudio 5? ===

No. AppStudio 5 does not have the interfaces required. AppStudio 5 is only designed to work with AppStudio Server.

=== Does it cost extra to use Volt? ===

If you purchase a subscription to AppStudio, then Volt is free for the duration of your subscription. We highly suggest purchasing a subscription to get the most out of AppStudio and Volt.

A limited version of Volt for free with the AppStudio 6 demo.

=== When I try to reset my password I get a message "Unauthorized". What do I do? ===

Account activation expires after an hour. Fortunately, getting a new link is easy:

1. Navigate to [https://dashboard.voltcloud.io/](https://dashboard.voltcloud.io/)
2. Click on “Forgot your password?”
3. Enter in the email address you registered with.
4. A new email should arrive shortly.

Faq

2017-05-18T18:42:04Z

Sarah: Frequently asked questions about Volt.

== General ==

=== What is Volt? ===
Volt is a platform to electrify your web apps! It provides simple hosting and extended services for your web and mobile apps via an easy to use interface to deploy your apps, and custom names using full HTTPS on a fast, stable platform.

Extended services currently include user management and server storage. We would like to offer a steady stream of additional services, and would like to hear from you about what services would make your experience using Volt better! [mailto:support@nsbasic.com Let us know what you're interested in!]

=== How safe is my data? ===

The safety of your data is top priority to us! Your data is backed up by a reliable and redundant on-site solution, and hard drive failures are tolerated by utilizing [https://en.wikipedia.org/wiki/RAID RAID] across many drives.

Additionally, the Volt server is built on industry standard technology - updates and security advisories are installed on a continuous basis.

=== What does it cost to use? ===

There is no initial cost to use Volt. Several tiered service plans will be available depending on your needs, but we expect there will always be a free plan.

=== Can I host my apps on it? ===

Yes. When you deploy your app to Volt, we take care of the rest. No worries about security certificates, MIME type configuration, updating servers or maintaining the server stack.

=== I used to host my web app on Dropbox. Can I use Volt instead? ===

Yes, Volt is designed to be the optimal server for web apps!

Dropbox announced that on Oct 3, 2016, [https://www.dropbox.com/help/files-folders/public-folder they will no longer allow content to display in-browser]. Acting as a web server isn’t what they wanted to do.

=== Can I run PHP on Volt? ===

We are moving away from the use of PHP because it can be tricky, especially for new users, and it's a chore to set up and maintain. Volt is designed to have many of the same features you get using PHP, but in a vastly easier-to-use environment!

=== I need a custom service. Can I talk to you about it? ===

Yes. Drop us a line at [mailto:support@nsbasic.com support@nsbasic.com]. If we think your idea might be useful to other users (and you don’t mind), we’ll even give you a break on the dev costs!

=== Volt calls my app https://mygreatapp.volt.live. Can I use my own URL? ===

This service will be available soon. You will be able to use a URL of your choice (like https://mygreatapp.com), so long as you control the domain.

While some setup will be needed to use this service, the result will be that your apps will look like they originate from your website, but are actually served by Volt.

=== Are there any restrictions on what I can do with Volt? ===

Nearly any legal use is acceptable. You can learn more from our [https://www.nsbasic.com/app/AppStudioTOS.txt terms of service].

=== Who can use it? ===

Initially, just AppStudio users. However, you can [mailto:support@nsbasic.com contact us] to request early access if you're not an AppStudio user. Note that the service is just launching and we're still likely to make changes to it.

== AppStudio Users ==

=== How is this different from the AppStudio Server (nsbapp.com)? ===

The AppStudio Server was designed to help with development, but not permanent hosting. Volt is a permanent hosting solution. It provides all the tools you need to either host your app, or provide a backend for a hybrid app or existing server.

=== Can I continue to use the AppStudio Server? ===

If you are on AppStudio 5 or older, the AppStudio server will continue to work until May 1st, 2017. AppStudio 6 always uses Volt.

=== How do I sign up for Volt? ===

Volt is free with your [https://www.nsbasic.com/i/Subscription/ subscription] to AppStudio 6! By subscribing you’ll receive continual updates to AppStudio, plus access to Volt Essential - our new cloud services platform built from the ground up to work with AppStudio.

If you are using a demo of AppStudio 6, you are able to sign up at our Starter level for free by clicking on the “Run” menu and choosing “Sign-up/Sign-in to Volt”.

=== Why has AppStudio switched to subscription billing? ===

In order to continue providing you with the innovative, high quality product you are used to, AppStudio has transitioned to a subscription billing. This transition will not only allow us to continue making AppStudio more useful to you, but also allow us to provide tight integration with a cloud service provider built from the ground up for AppStudio - namely Volt.

=== Can I use Volt with AppStudio 5? ===

No. AppStudio 5 does not have the interfaces required. AppStudio 5 is only designed to work with AppStudio Server.

=== Does it cost extra to use Volt? ===

If you purchase a subscription to AppStudio, then Volt is free for the duration of your subscription. We highly suggest purchasing a subscription to get the most out of AppStudio and Volt.

A limited version of Volt can be used without a subscription to AppStudio.

=== When I try to reset my password I get a message "Unauthorized". What do I do? ===

Account activation expires after an hour. Fortunately, getting a new link is easy:

1. Navigate to [https://dashboard.voltcloud.io/](https://dashboard.voltcloud.io/)
2. Click on “Forgot your password?”
3. Enter in the email address you registered with.
4. A new email should arrive shortly.

Volt Documentation

2017-05-13T04:45:12Z

Sarah: Landing page for all Volt documentation and support articles

Volt is a platform to electrify your web apps. It provides simple hosting and extended services for your web and mobile apps. As a web host, it provides an easy to use interface to deploy apps, custom names using full HTTPS on a fast, stable platform.

Extended services like user management and server storage are available.

== Getting Started ==
* [[faq|Frequently Asked Questions]]
* [[first_app|Your First Volt App]]
* [[error_handling|Handling Errors]]

== Authentication ==
* [[user_confirmation|User Confirmation]]
* [[resetting_passwords|Resetting Passwords]]
* [[user_registration|Register a User]]
* [[log_in|Logging In (and Out)]]

== Users ==
* [[current_user|Working with the Current User]]
* [[manage_users|Managing Your Users]]

== Apps ==
* [[manage_apps|Managing Your Apps]]

== Services ==
* [[server_storage|Server Storage]]
* [[app_storage|App Storage]]
* [[send_email|Sending Email]]

== AppStudio ==
* [[volt_for_appstudio|Volt for AppStudio Users]]