Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicocrmapi\apiCrmPreferenciausua.p

 

Objetivo

Retornar as preferências do usuário logado.

 

Tabelas Temporárias

Atributos das tabelas temporárias de entrada e saída:

ttParamUser

 

Atributo

Tipo

Formato

        Descrição

Obr.

nomCampoChave

Char

 

Campo chave

sim

 

tt

Tabela definida conforme tabela <>, porém com as diferenças abaixo.

Atributo

Tipo

Formato

        Descrição

Obr.

 

 

 

 

 

 

Parâmetros de input e output da api

 

Parâmetro

Tipo

Formato

I

O

IO

Descrição

 

 

 

 

 

 

 

 

Métodos

Métodos básicos

 

Método: defaultFilter

Descrição: retorna o campo a ser utilizado como filtro default para o usuário.

Requisitos: nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pcUser

Char

 

X

 

 

Usuário

pcProg

Char

 

X

 

 

Programa

Idx

Int

 

 

X

 

Índice do combo(filtro)

 

Método: defaultUserFilter

Descrição: retorna as preferências do usuário. 

Requisitos: nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pcUser

Char

 

X

 

 

Usuário

ttParamUser

Tt

 

 

X

 

Preferências do usuário

 

Método: findUserLogged

Descrição: retorna o usuário logado.

Requisitos: nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pcUser

Char

 

 

X

 

usuario