VUserList class reference

Representa a una lista de usuarios declarados en el servidor de aplicaciones.

Esta clase se ha incorporado al API en la versión 7.16.

Funciones

Constructor
Función
VUserList()
Funciones generales
Retorno Función
void append( VUser user )
void append( VUserList userList )
VUser getAt( Number index )
void removeAll()
void removeAt( Number index )
Number size()
void sortByFullName()
void sortById()
void sortByName()

Documentación de funciones

Constructor

VUserList()

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

Funciones generales

void append( VUser user )

Añade un usuario a la lista.

Parámetros:

  • user: objeto de la clase VUser.

void append( VUserList userList )

Añade una lista de usuarios a la lista.

Parámetros:

  • userList: objeto de la clase VUserList.

VUser getAt( Number index )

Devuelve un objeto de la clase VUser con el usuario correspondiente a la posición especificada en el parámetro index.

Parámetros:

  • index: número que contiene la posición del usuario en la lista. La primera posición es la 0.

void removeAll()

Quitar todos los usuarios de la lista. Es decir, deja una lista de usuarios vacía. Esta función no elimina los usuarios del servidor.

void removeAt( Number index )

Quitar de la lista de usuarios el usuario que ocupa la posición indicada en el parámetro index.

Esta función no elimina los usuarios del servidor.

Parámetros:

  • index: número que contiene la posición del usuario en la lista. La primera posición es la 0.

Number size()

Devuelve el tamaño de lista, es decir el número de usuarios que contiene la lista.

void sortByFullName()

Clasifica la lista de usuarios por el nombre completo de los usuarios.

void sortById()

Clasifica la lista de usuarios por el id de los usuarios.

void sortByName()

Clasifica la lista de usuarios por el nombre de los usuarios.

Ejemplos

Ejemplo de como leer los usuarios y sus grupos

//-------------------------------
//Leer usuarios y sus grupos
//-------------------------------
importApi("AdminApi");
var listaUsuarios = new VUserList();
if (theServerAdmin.getAllUsers(listaUsuarios))
{
     var usuario = new VUser();
     var grupo = new VUserGroup();
     var numUsuarios = listaUsuarios.size();

     for (var numUsuario = 0; numUsuario < numUsuarios; numUsuario++)
     {
          usuario = listaUsuarios.getAt(numUsuario);
          alert("Usuario: " + usuario.id() + " " + usuario.name());

          numGrupos = usuario.groupCount();

          for (var numGrupo = 0; numGrupo < numGrupos; numGrupo++)
          {
               theServerAdmin.getUserGroupById(usuario.groupCodeAt(numGrupo), grupo);
               alert("Grupo: " + grupo.id() + " " + grupo.name());
          };
     };
};

results matching ""

    No results matching ""