Group
Management of the application groups and obtaining the authenticated user's group data.
all
_group.all() : java.util.List
Description
Obtém a lista de dados de todos os grupo.
How To Use
// Retorna todos os grupos existentes.
_out.json(_group.all())
Return
( java.util.List )
Lista de todos os dados de todos os grupos.
allByCode
_group.allByCode(codigo: string) : java.util.List
Description
Obtém todos os grupos a partir do código alternativo.
How To Use
// Lista em log os grupos que tem o código exemplo.
const grupos = _group.allByCode("exemplo")
for (const grupo of grupos) {
_log.info(`Grupo ${grupo.getString("name")}`)
}
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
codigo | string | Código alternativo que os grupos podem ter associado. |
Return
( java.util.List )
Lista dos utilizadores encontrados para o código alternativo.
code
_group.code() : string
Description
Obtém o código alternativo do grupo do utilizador que está autenticado.
How To Use
// Código auxiliar do grupo do utilizador autenticado.
_log.info(`Código do Utilizador: ${_group.code()}`)
Return
( string )
Código auxiliar do grupo do utilizador logado.
create
_group.create(dadosGrupo: Values) : int
Description
Cria o novo grupo.
How To Use
// Criar um novo grupo:
_group.create(
_val.map()
.set("name", "Exemplo")
.set("mail", "grupo@exemplo.com")
// É opcional definir um código alternativo auxiliar:
.set("code", "identificacao-alternativa-de-exemplo")
)
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
dadosGrupo | Values | Dados do grupo que vai ser criado. |
Return
( int )
ID do grupo que foi criado.
createIfNotExists
_group.createIfNotExists(dadosGrupo: Values) : boolean
Description
Cria o utilizador caso não exista ainda.
How To Use
// Criar um novo grupo caso não exista ainda:
_group.createIfNotExists(
_val.map()
.set("name", "Exemplo")
.set("mail", "grupo@exemplo.com")
// É opcional definir um código alternativo auxiliar:
.set("code", "identificacao-alternativa-de-exemplo")
)
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
dadosGrupo | Values | Dados do grupo que vai ser criado caso não exista ainda. |
Return
( boolean )
It was successfully created.
data
_group.data() : Values
Description
Obtém toda a informação de dados do grupo do utilizador que está autenticado.
How To Use
// Toda informação do grupo do utilizador autenticado.
_out.json(_group.data())
Return
( Values )
Todos os dados do grupo do utilizador logado.
firstByCode
_group.firstByCode(codigo: string) : Values
Description
Obtém os dados de um grupo a partir do código alternativo.
How To Use
// Grupo que tem o código exemplo.
const grupo = _group.firstByCode("exemplo")
_out.json(grupo)
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
codigo | string | Código alternativo que o grupo pode ter associado. |
Return
( Values )
Dados do grupo encontrado com o código alternativo.
firstByMail
_group.firstByMail(mail: string) : Values
Description
Obtém os dados de um grupo a partir do e-mail.
How To Use
// Grupo obtido a partir do e-mail.
const grupo = _group.firstByMail("grupo@exemplo.com")
_out.json(grupo)
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
string | E-mail do grupo. |
Return
( Values )
Dados do grupo encontrado com o e-mail.
firstByName
_group.firstByName(nome: string) : Values
Description
Obtém os dados de um grupo a partir do nome.
How To Use
// Grupo que tem o nome.
const grupo = _group.firstByName("Exemplo")
_out.json(grupo)
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
nome | string | Nome do grupo. |
Return
( Values )
Dados do utilizador encontrado com o nome.
get
_group.get(id: int) : Values
Description
Obtém os dados de um grupo a partir do ID (identificador numérico).
How To Use
// Grupo obtido a partir do ID.
const grupo = _group.get(1)
_out.json(grupo)
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
id | int | Identificador numérico do grupo. |
Return
( Values )
Dados do grupo encontrado.
_group.get(idOuUid: string) : Values
Description
Obtém os dados de um grupo a partir do ID (identificador numérico) ou do UUID (identificador único universal).
How To Use
// Grupo obtido a partir do UID.
const grupo = _group.get("0dd572b8-7841-4977-80de-abb9660a0df0")
_out.json(grupo)
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
idOuUid | string | Tanto pode ser um ID ou um UID do grupo. |
Return
( Values )
Dados do grupo encontrado.