Group · Doc

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

all

_group.all() : java.util.List

Descrição

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

Como Usar

// Retorna todos os grupos existentes.
_out.json(_group.all())

Retorno

( java.util.List )

Lista de todos os dados de todos os grupos.

allByCode

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

Descrição

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

Como Usar

// 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")}`)
}

Atributos

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

Retorno

( java.util.List )

Lista dos utilizadores encontrados para o código alternativo.

code

_group.code() : string

Descrição

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

Como Usar

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

Retorno

( string )

Código auxiliar do grupo do utilizador logado.

create

_group.create(dadosGrupo: Values) : int

Descrição

Cria o novo grupo.

Como Usar

// 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")
)

Atributos

NOME	TIPO	DESCRIÇÃO
dadosGrupo	Values	Dados do grupo que vai ser criado.

Retorno

( int )

ID do grupo que foi criado.

createIfNotExists

_group.createIfNotExists(dadosGrupo: Values) : boolean

Descrição

Cria o utilizador caso não exista ainda.

Como Usar

// 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")
)

Atributos

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

Retorno

( boolean )

Foi criado com sucesso.

data

_group.data() : Values

Descrição

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

Como Usar

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

Retorno

( Values )

Todos os dados do grupo do utilizador logado.

firstByCode

_group.firstByCode(codigo: string) : Values

Descrição

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

Como Usar

// Grupo que tem o código exemplo.
const grupo = _group.firstByCode("exemplo")
_out.json(grupo)

Atributos

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

Retorno

( Values )

Dados do grupo encontrado com o código alternativo.

firstByMail

_group.firstByMail(mail: string) : Values

Descrição

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

Como Usar

// Grupo obtido a partir do e-mail.
const grupo = _group.firstByMail("grupo@exemplo.com")
_out.json(grupo)

Atributos

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

Retorno

( Values )

Dados do grupo encontrado com o e-mail.

firstByName

_group.firstByName(nome: string) : Values

Descrição

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

Como Usar

// Grupo que tem o nome.
const grupo = _group.firstByName("Exemplo")
_out.json(grupo)

Atributos

NOME	TIPO	DESCRIÇÃO
nome	string	Nome do grupo.

Retorno

( Values )

Dados do utilizador encontrado com o nome.

get

_group.get(id: int) : Values

Descrição

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

Como Usar

// Grupo obtido a partir do ID.
const grupo = _group.get(1)
_out.json(grupo)

Atributos

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

Retorno

( Values )

Dados do grupo encontrado.

_group.get(idOuUid: string) : Values

Descrição

Obtém os dados de um grupo a partir do ID (identificador numérico) ou do UUID (identificador único universal).

Como Usar

// Grupo obtido a partir do UID.
const grupo = _group.get("0dd572b8-7841-4977-80de-abb9660a0df0")
_out.json(grupo)

Atributos

NOME	TIPO	DESCRIÇÃO
idOuUid	string	Tanto pode ser um ID ou um UID do grupo.

Retorno

( Values )

Dados do grupo encontrado.

id

_group.id() : int

Descrição

Obtém o identificador númerico do grupo de quem está autenticado.

Como Usar

// ID do grupo do utilizador autenticado.
_log.info(`ID do Grupo: ${_group.id()}`)

Retorno

( int )

ID (identificador númerico) do grupo do utilizador logado.

load

_group.load() : Group

Retorno

( Group )

name

_group.name() : string

Descrição

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

Como Usar

// Nome do grupo do utilizador autenticado.
_log.info(`Nome do Grupo: ${_group.name()}`)

Retorno

( string )

Nome do grupo do utilizador logado.

remove

_group.remove(id: int) : boolean

Descrição

Remove o grupo refente ao ID passado.

Como Usar

// Remove o grupo:
const grupo = _group.firstByCode("exemplo")
_group.remove(
    grupo.getInt("id")
)

Atributos

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

Retorno

( boolean )

Foi apagado com sucesso.

search

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

Descrição

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

Como Usar

// Pesquisa grupos com o nome "Exemplo".
const grupos = _group.search("Exemplo")
for (const grupo of grupos) {
    _log.info(`Grupo encontrado ${grupo.getString("name")}`)
}

Atributos

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

Retorno

( java.util.List )

Lista de dados dos grupos encontrados.

searchFirst

_group.searchFirst(termo: string) : Values

Descrição

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

Como Usar

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

Atributos

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

Retorno

( Values )

Dados do grupo encontrado.

uid

_group.uid() : string

Descrição

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

Como Usar

// UUID do grupo do utilizador autenticado.
_log.info(`UID do Grupo: ${_group.uid()}`)

Retorno

( string )

UUID (identificador único universal) do grupo do utilizador logado.

update

_group.update(id: int, dadosGrupo: Values) : boolean

Descrição

Atualiza os dados do grupo referente ao ID passado.

Como Usar

// Atualiza o grupo:
const grupo = _group.firstByMail("grupo@exemplo.com")
grupo.set("name", "Novo Nome")
_group.update(
    grupo.getInt("id"),
    grupo
)

Atributos

NOME	TIPO	DESCRIÇÃO
id	int	O ID (identificador númerico) do grupo.
dadosGrupo	Values	Dados do grupo para atualizar a informação armazenada em base de dados.

Retorno

( boolean )

Foi atualizado com sucesso.

_group.update(dadosUtilizador: Values) : boolean

Descrição

Atualiza os dados do grupo referente ao ID passado.

Como Usar

// Atualiza o utilizador:
const grupo = _group.firstByMail("grupo@exemplo.com")
grupo.set("name", "Novo Nome")
_group.update(
    grupo
)

Atributos

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

Retorno

( boolean )

Foi atualizado com sucesso.