Ghenne at 15:22, 25 February 2021

2021-02-25T15:22:22Z

← Older revision		Revision as of 15:22, 25 February 2021
Line 9:		Line 9:
	'''$volt.use.get'''(''callback'')		'''$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).		* ''callback'' - function(error, data), required. The function in your app to call when the request to VoltServer is complete (or fails).

	<syntaxhighlight lang="JavaScript">		<syntaxhighlight lang="JavaScript">
Line 49:		Line 49:
	</syntaxhighlight>		</syntaxhighlight>

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

	<syntaxhighlight lang="json">		<syntaxhighlight lang="json">
Line 70:		Line 70:

	* ''data'' - object, required. An object with the user details to update.		* ''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).		* ''callback'' - function(error, data), required. The function in your app to call when the request to VoltServer is complete (or fails).

	The data object should be of the following form:		The data object should be of the following form:
Line 129:		Line 129:
	'''$volt.user.delete'''(''callback'')		'''$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).		* ''callback'' - function(error, data), required. The function in your app to call when the request to VoltServer is complete (or fails).

	<syntaxhighlight lang="JavaScript">		<syntaxhighlight lang="JavaScript">

Sarah: Instructions for creating and working with the current user

2017-05-26T23:23:23Z

Instructions for creating and working with the current user

New page

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]

Current user - Revision history

Ghenne at 15:22, 25 February 2021

Sarah: Instructions for creating and working with the current user