VUser

Representa a un usuario declarado en el servidor de aplicaciones.

Indice de funciones

Constructor

VUser()

Generales

void changePassword( String newPassWord )

String comments()

String email()

String fullName()

Number id()

String name()

void setComments( String text )

void setEmail (String email)

void setFullName( String fullName )

void setName( String name )

De estilos

Boolean changePasswordNextConnect()

Boolean isAccountBlocked()

Boolean isAccountDisabled()

Boolean isAdministrator()

Boolean passwordNotExpire()

void setAccountBlocked( Boolean set )

void setAccountDisabled( Boolean set )

void setAdministrator( Boolean set )

void setChangePasswordNextConnect(Boolean set )

void setPasswordNotExpire( Boolean set )

De grupos

Boolean addGroup( Number groupCode )

Number groupCodeAt( Number index )

Number groupCount()

Boolean isGroupMember( Number groupCode )

Boolean removeGroup( Number groupCode )

Documentación de funciones

Constructor

VUser()

Constructor. Crea una instancia de objeto de la clase VUser.

Funciones generales

void changePassword( String newPassWord );

Modifica la contraseña del usuario. Esta función puede usarse para asignar la contraseña al usuario cuando se crea nuevo y también para modificar la contraseña de un usuario existente.

Parámetros:

• newPassword: texto con la nueva contraseña del usuario.

String comments()

Devuelve los comentarios del usuario.

String email()

Devuelve el email del usuario.

String fullName()

Devuelve el nombre completo del usuario.

Number id()

Devuelve el código numérico único del usuario.

String name()

Devuelve el nombre del usuario.

void setComments( String text )

Modifica los comentarios del usuario.

Parámetros:

• text: texto de los comentarios a grabar en el usuario.

void setEmail( String email)

Modifica el email del usuario.

Parámetros:

• email: dirección de correo electrónico del usuario.

void setFullName( String fullName )

Modifica el nombre completo del usuario.

Parámetros:

• fullName: texto con el nombre completo a grabar en el usuario.

void setName( String name )

Modifica el nombre del usuario.

Parámetros:

• name: texto con el nombre del usuario a grabar.

Este comando solo funcionará en la creación de un nuevo usuario, es decir, mientras no tenga asignado el id, una vez que usuario ha sido creado y tiene asignado un id esta función no será funcional y no modificará el nombre del usuario. Este control se realiza para asegurar que un usuario no puede modificar su nombre una vez creado.

Funciones de estilos

Boolean changePasswordNextConnect()

Activa en el usuario el check "Debe cambiar la contraseña en la siguiente conexión".

Boolean isAccountBlocked()

Devuelve true si el usuario está bloqueado, devuelve false en caso contrario.

Boolean isAccountDisabled()

Devuelve true si el usuario está desactivado, devuelve false en caso contrario.

Boolean isAdministrator()

Devuelve true si el usuario está marcado como supervisor, devuelve false en caso contrario.

Boolean passwordNotExpire()

Devuelve true si el usuario tiene activado el check "La contraseña nunca caduca", devuelve false en caso contrario.

void setAccountBlocked( Boolean set )

Modifica el check del usuario "cuenta bloqueada" permitiendo bloquearla o desbloquearla en función del parámetro.

Parámetros:

• set: true para bloquear la cuenta, false para desbloquearla.

void setAccountDisabled( Boolean set )

Modifica el check del usuario "cuenta desactivada" permitiendo activarla o desactivarla en función del parámetro.

Parámetros:

• set: true para activar la cuenta, false para desactivarla.

void setAdministrator( Boolean set )

Modifica el check del usuario "supervisor" permitiendo activarlo o desactivarlo en función del parámetro.

Parámetros:

• set: true para hacer al usuario supervisor, false para que el usuario no sea supervisor.

void setChangePasswordNextConnect(Boolean set )

Cambia el check del usuario "Debe cambiar la contraseña en la siguiente conexión" en función del parámetro, permitiendo activar o desactivar el cambio de contraseña en la siguiente conexión.

Parámetros:

• set: true para activar el cambio de contraseña, false para desactivarlo.

void setPasswordNotExpire( Boolean set )

Cambia el check del usuario "La contraseña nunca caduca" en función del parámetro, permitiendo activar o desactivar que la contraseña caduque.

Parámetros:

• set: true para marcar que la contraseña nunca caduca, false para indicar que caduca.

Funciones de grupos

Boolean addGroup( Number groupCode )

Añade el usuario del grupo especificado en el parámetro. Devuelve true si el usuario ha podido ser añadido correctamente y false en caso contrario.

Parámetros:

• groupCode: código numérico del grupo de usuario.

Number groupCodeAt( Number index )

Un usuario puede pertenecer a múltiples grupos de usuario. Con la función groupCount() podemos saber a cuantos grupos pertenece el usuario. Esta función devuelve el código numérico del grupo de usuario correspondiente al índice especificado en el parámetro.

Esta función nos permitiría recorrer la lista de grupos del usuario obteniendo el código numérico de cada uno de ellos.

Parámetros:

• index: número de índice. El primer grupo de usuario es el 0.

Number groupCount()

Devuelve el número de grupos a los que pertenece el usuario.

Boolean isGroupMember( Number groupCode )

Devuelve true si el usuario pertenece al grupo especificado en el parámetro, devuelve false en caso contrario.

Parámetros:

• groupCode: código numérico del grupo de usuario.

Boolean removeGroup( Number groupCode )

Elimina el usuario del grupo especificado en el parámetro. Devuelve true si el usuario ha podido ser eliminado correctamente y false en caso contrario.

Parámetros:

• groupCode: código numérico del grupo de usuario.

Ejemplos

1. Ejemplo de cómo crear un nuevo usuario

//--------------------------
//Crear un nuevo usuario
//--------------------------
importApi("AdminApi");

var usuarioNuevo = new VUser();
usuarioNuevo.setName("prueba");
usuarioNuevo.setFullName("Nombre apellidos");
alert(theServerAdmin.addUser(usuarioNuevo));

2. Quitar un grupo de usuarios de un usuario

//Quitar un grupo de usuarios de un usuario

importApi("AdminApi"); 

var usuario = "Fran"; 
var grupo = "Administradores"; 

var user = new VUser(); 
var group = new VUserGroup(); 

theServerAdmin.getUserByName(usuario, user); 
theServerAdmin.getUserGroupByName(grupo, group); 
user.removeGroup(group.id()) 
theServerAdmin.modUser( user );