User

Gestão dos utilizadores da aplicação e obtenção dos dados do utilizador autenticado.

all

_user.all() : java.util.List

Descrição

Obtém a lista de dados de todos os utilizadores.

Como Usar

// Retorna todos os utilizadores existentes.
_out.json(_user.all())

Retorno

( java.util.List )

Lista de todos os dados de todos os utilizadores.

allByCode

_user.allByCode(codigo: string) : java.util.List

Descrição

Obtém todos os utilizadores a partir do código alternativo.

Como Usar

// Lista em log os utilizadores que tem o código exemplo.
const utilizadores = _user.allByCode("exemplo")
for (const utilizador of utilizadores) {
    _log.info(`Utilizador ${utilizador.getString("name")}`)
}

Atributos

NOME	TIPO	DESCRIÇÃO
codigo	string	Código alternativo que os utilizadores podem ter associado.

Retorno

( java.util.List )

Lista dos utilizadores encontrados para o código alternativo.

allProvidersData

_user.allProvidersData() : Values

Retorno

( Values )

_user.allProvidersData(userId: int) : Values

Atributos

NOME	TIPO	DESCRIÇÃO
userId	int

Retorno

( Values )

code

_user.code() : string

Descrição

Obtém o código alternativo do utilizador que está autenticado.

Como Usar

// Código auxiliar do utilizador autenticado.
_log.info(`Código do Utilizador: ${_user.code()}`)

Retorno

( string )

Código auxiliar do utilizador logado.

create

_user.create(dadosUtilizador: Values) : int

Descrição

Cria o novo utilizador.

Como Usar

// Criar um novo utilizador:
const grupo = _group.firstByCode("exemplo")
_user.create(
    _val.map()
        .set("name", "Nome Completo")
        .set("mail", "utilizador@exemplo.com")
        .set("user", "utilizador")
        .set("pass", "PasswordSecreta123")
        .set("group_id", grupo.getInt("id"))
        // É opcional definir um código alternativo auxiliar:
        .set("code", "identificacao-alternativa-de-exemplo")
)

Atributos

NOME	TIPO	DESCRIÇÃO
dadosUtilizador	Values	Dados do utilizador que vai ser criado.

Retorno

( int )

ID do utilizador que foi criado.

createIfNotExists

_user.createIfNotExists(dadosUtilizador: Values) : boolean

Descrição

Cria o utilizador caso não exista ainda.

Como Usar

// Criar um novo utilizador caso não exista ainda:
const grupo = _group.firstByCode("generico")
_user.createIfNotExists(
    _val.map()
        .set("name", "Nome Completo")
        .set("mail", "utilizador@exemplo.com")
        .set("user", "utilizador")
        .set("pass", "PasswordSecreta123")
        .set("group_id", grupo.getInt("id"))
        // É opcional definir um código alternativo auxiliar:
        .set("code", "identificacao-alternativa-de-exemplo")
)

Atributos

NOME	TIPO	DESCRIÇÃO
dadosUtilizador	Values	Dados do utilizador que vai ser criado caso não exista ainda.

Retorno

( boolean )

Foi criado com sucesso.

data

_user.data() : Values

Descrição

Obtém toda a informação de dados do utilizador que está autenticado.

Como Usar

// Toda informação do utilizador autenticado.
_out.json(_user.data())

Retorno

( Values )

Todos os dados do utilizador logado.

firstByCode

_user.firstByCode(codigo: string) : Values

Descrição

Obtém os dados de um utilizador a partir do código alternativo.

Como Usar

// Utilizador que tem o código exemplo.
const utilizador = _user.firstByCode("exemplo")
_out.json(utilizador)

Atributos

NOME	TIPO	DESCRIÇÃO
codigo	string	Código alternativo que o utilizador pode ter associado.

Retorno

( Values )

Dados do utilizador encontrado com o código alternativo.

firstByMail

_user.firstByMail(mail: string) : Values

Descrição

Obtém os dados de um utilizador a partir do e-mail.

Como Usar

// Utilizador obtido a partir do e-mail.
const utilizador = _user.firstByMail("utilizador@exemplo.com")
_out.json(utilizador)

Atributos

NOME	TIPO	DESCRIÇÃO
mail	string	E-mail do utilizador.

Retorno

( Values )

Dados do utilizador encontrado com o e-mail.

firstByName

_user.firstByName(nome: string) : Values

Descrição

Obtém os dados de um utilizador a partir do nome completo.

Como Usar

// Utilizador que tem o nome completo.
const utilizador = _user.firstByName("Nome Completo")
_out.json(utilizador)

Atributos

NOME	TIPO	DESCRIÇÃO
nome	string	Nome completo do utilizador.

Retorno

( Values )

Dados do utilizador encontrado com o nome completo.

firstByUser

_user.firstByUser(utilizador: string) : Values

Descrição

Obtém os dados de um utilizador a partir do nome de utilizador, mesmo nome utilizado no login.

Como Usar

// Utilizador a partir do username.
const utilizador = _user.firstByMail("utilizador@exemplo.com")
_out.json(utilizador)

Atributos

NOME	TIPO	DESCRIÇÃO
utilizador	string	Username do utilizador.

Retorno

( Values )

Dados do utilizador encontrado com o nome de utilizador.

get

_user.get(id: int) : Values

Descrição

Obtém os dados de um utilizador a partir do ID (identificador numérico).

Como Usar

// Utilizador obtido a partir do ID.
const utilizador = _user.get(1)
_out.json(utilizador)

Atributos

NOME	TIPO	DESCRIÇÃO
id	int	Identificador numérico do utilizador.

Retorno

( Values )

Dados do utilizador encontrado.

_user.get(idOuUidOuUsername: string) : Values

Descrição

Obtém os dados de um utilizador a partir do ID (identificador numérico), ou do UUID (identificador único universal) ou ainda o nome de utilizador.

Como Usar

// Utilizador obtido a partir do UUID.
const utilizador = _user.get("7901e01c-c53e-42c2-980d-9f928090422f")
_out.json(utilizador)

Atributos

NOME	TIPO	DESCRIÇÃO
idOuUidOuUsername	string	Tanto pode ser um ID, ou um UID, ou ainda o username.

Retorno

( Values )

Dados do utilizador encontrado.

hasProvider

_user.hasProvider(userId: int, providerCode: string) : boolean

Atributos

NOME	TIPO	DESCRIÇÃO
userId	int
providerCode	string

Retorno

( boolean )

_user.hasProvider(providerCode: string) : boolean

Atributos

NOME	TIPO	DESCRIÇÃO
providerCode	string

Retorno

( boolean )

id

_user.id() : int

Descrição

Obtém o identificador numérico de quem está autenticado.

Como Usar

// ID do utilizador autenticado.
_log.info(`ID do Utilizador: ${_user.id()}`)

Retorno

( int )

ID (identificador númerico) do utilizador logado.

load

_user.load() : User

Retorno

( User )

name

_user.name() : string

Descrição

Obtém o nome completo do utilizador que está autenticado.

Como Usar

// Nome do utilizador autenticado.
_log.info(`Nome completo do Utilizador: ${_user.name()}`)

Retorno

( string )

Nome completo do utilizador logado.

noPassword

_user.noPassword(active: boolean) : boolean

Atributos

NOME	TIPO	DESCRIÇÃO
active	boolean

Retorno

( boolean )

_user.noPassword(id: int, active: boolean) : boolean

Atributos

NOME	TIPO	DESCRIÇÃO
id	int
active	boolean

Retorno

( boolean )

password

_user.password(id: int, password: string) : boolean

Atributos

NOME	TIPO	DESCRIÇÃO
id	int
password	string

Retorno

( boolean )

_user.password(password: string) : boolean

Atributos

NOME	TIPO	DESCRIÇÃO
password	string

Retorno

( boolean )

providerData

_user.providerData(userId: int, providerCode: string) : Values

Atributos

NOME	TIPO	DESCRIÇÃO
userId	int
providerCode	string

Retorno

( Values )

_user.providerData(providerCode: string) : Values

Atributos

NOME	TIPO	DESCRIÇÃO
providerCode	string

Retorno

( Values )

providerDataByUid

_user.providerDataByUid(uid: string) : Values

Atributos

NOME	TIPO	DESCRIÇÃO
uid	string

Retorno

( Values )

providerLDAP

_user.providerLDAP(active: boolean) : boolean

Atributos

NOME	TIPO	DESCRIÇÃO
active	boolean

Retorno

( boolean )

_user.providerLDAP(id: int, active: boolean) : boolean

Atributos

NOME	TIPO	DESCRIÇÃO
id	int
active	boolean

Retorno

( boolean )

remove

_user.remove(id: int) : boolean

Descrição

Remove o utilizador refente ao ID passado.

Como Usar

// Remove o utilizador:
const utilizador = _user.firstByCode("exemplo")
_user.remove(
    utilizador.getInt("id")
)

Atributos

NOME	TIPO	DESCRIÇÃO
id	int	O ID (identificador númerico) do utilizador.

Retorno

( boolean )

Foi apagado com sucesso.

search

_user.search(termo: string) : java.util.List

Descrição

Pesquisa os utilizadores que tem alguma ocorrência nos dados com o texto de pesquisa passado.

Como Usar

// Pesquisa utilizadores com o sobrenome "Apelido".
const utilizadores = _user.search("Apelido")
for (const utilizador of utilizadores) {
    _log.info(`Utilizador encontrado ${utilizador.getString("name")}`)
}

Atributos

NOME	TIPO	DESCRIÇÃO
termo	string	Chave de pesquisa.

Retorno

( java.util.List )

Lista de dados dos utilizadores encontrados.

searchFirst

_user.searchFirst(termo: string) : Values

Descrição

O primeiro resultado da pesquisa de utilizadores que tem alguma ocorrência nos dados do termo passado.

Como Usar

// O primeiro utilizador que tem o e-mail com @exemplo.com.
const utilizador = _user.search("@exemplo.com")
_out.json(utilizador)

Atributos

NOME	TIPO	DESCRIÇÃO
termo	string	Chave de pesquisa.

Retorno

( Values )

Dados do utilizador encontrado.

setNoPassword

_user.setNoPassword(active: boolean) : boolean

Atributos

NOME	TIPO	DESCRIÇÃO
active	boolean

Retorno

( boolean )

_user.setNoPassword(id: int, active: boolean) : boolean

Atributos

NOME	TIPO	DESCRIÇÃO
id	int
active	boolean

Retorno

( boolean )

setPassword

_user.setPassword(id: int, password: string) : boolean

Atributos

NOME	TIPO	DESCRIÇÃO
id	int
password	string

Retorno

( boolean )

_user.setPassword(password: string) : boolean

Atributos

NOME	TIPO	DESCRIÇÃO
password	string

Retorno

( boolean )

setProviderLDAP

_user.setProviderLDAP(active: boolean) : boolean

Atributos

NOME	TIPO	DESCRIÇÃO
active	boolean

Retorno

( boolean )

_user.setProviderLDAP(id: int, active: boolean) : boolean

Atributos

NOME	TIPO	DESCRIÇÃO
id	int
active	boolean

Retorno

( boolean )

uid

_user.uid() : string

Descrição

Obtém o identificador único universal de quem está autenticado.

Como Usar

// UUID do utilizador autenticado.
_log.info(`UID do Utilizador: ${_user.uid()}`)

Retorno

( string )

UUID (identificador único universal) do utilizador logado.

update

_user.update(id: int, dadosUtilizador: Values) : boolean

Descrição

Atualiza os dados do utilizador referente ao ID passado.

Como Usar

// Atualiza o utilizador:
const utilizador = _user.firstByMail("utilizador@exemplo.com")
utilizador.set("pass", "NovaPasswordSecreta123")
_user.update(
    utilizador.getInt("id"),
    utilizador,
    true
)

Atributos

NOME	TIPO	DESCRIÇÃO
id	int	O ID (identificador numérico) do utilizador.
dadosUtilizador	Values	Dados do utilizador para atualizar a informação armazenada em base de dados.

Retorno

( boolean )

Foi atualizado com sucesso.

_user.update(id: int, dadosUtilizador: Values, alterarPassword: boolean) : boolean

Descrição

Atualiza os dados do utilizador referente ao ID passado.

Como Usar

// Atualiza o utilizador:
const utilizador = _user.firstByMail("utilizador@exemplo.com")
utilizador.set("pass", "NovaPasswordSecreta123")
_user.update(
    utilizador.getInt("id"),
    utilizador,
    true
)

Atributos

NOME	TIPO	DESCRIÇÃO
id	int	O ID (identificador numérico) do utilizador.
dadosUtilizador	Values	Dados do utilizador para atualizar a informação armazenada em base de dados.
alterarPassword	boolean	Se deve realizar a alteração da palavra-passe ou senha.

Retorno

( boolean )

Foi atualizado com sucesso.

_user.update(dadosUtilizador: Values) : boolean

Descrição

Atualiza os dados do utilizador referente ao ID definido na estrutura de dados passada.

Como Usar

// Atualiza o utilizador:
const utilizador = _user.firstByMail("utilizador@exemplo.com")
utilizador.set("pass", "NovaPasswordSecreta123")
_user.update(
    utilizador,
    true
)

Atributos

NOME	TIPO	DESCRIÇÃO
dadosUtilizador	Values	Dados do utilizador para atualizar a informação armazenada em base de dados.

Retorno

( boolean )

Foi atualizado com sucesso.

_user.update(dadosUtilizador: Values, alterarPassword: boolean) : boolean

Descrição

Atualiza os dados do utilizador referente ao ID definido na estrutura de dados passada.

Como Usar

// Atualiza o utilizador:
const utilizador = _user.firstByMail("utilizador@exemplo.com")
utilizador.set("pass", "NovaPasswordSecreta123")
_user.update(
    utilizador,
    true
)

Atributos

NOME	TIPO	DESCRIÇÃO
dadosUtilizador	Values	Dados do utilizador para atualizar a informação armazenada em base de dados.
alterarPassword	boolean	Se deve realizar a alteração da palavra-passe ou senha.

Retorno

( boolean )

Foi atualizado com sucesso.

_user.user() : string

Descrição

Obtém o nome de utilizador de quem está autenticado.

Como Usar

// Nome do utilizador autenticado.
_log.info(`Nome completo do Utilizador: ${_user.name()}`)

Retorno

( string )

Nome de utilizador logado.