Home Page
English (1.167)
VersaCloud (1.163)
VersaCloud API 'CallbackAddAllow' Reference Documentation
Description
The following table displays the documentation for the 'CallbackAddAllow' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Requests to add a new (or modify an existing) callback for a specific method already defined on VersaCloud |
Español (moderno) |
Solicita añadir un nuevo (o alterar un existente) callback para un método específico ya definido en VersaCloud |
Português (Brasil) |
Solicita adicionar um novo (ou modificar um existente) callback para um método específico já definido em VersaCloud |
Parameters
The following table describes all of 'CallbackAddAllow''s parameters, in every language available.
ID |
Name |
Language |
Description |
Type |
Min-Max Length |
Reentr Key Member |
Optional |
|---|---|---|---|---|---|---|---|
1 |
Login |
English (United States) |
Operation handle returned from succesful call of UserLoginAllow, identifying user |
48-48 |
No |
No |
|
2 |
SolutionToken |
English (United States) |
Master solution token identifying solution the method being modified belongs to |
128-128 |
Yes |
No |
|
3 |
MethodName |
English (United States) |
Name of method to have a callback added |
6-64 |
Yes |
No |
|
4 |
CallbackID |
English (United States) |
Callback's ID (a positive integer identifying this callback uniquely among the method's callbacks - shared by rollback callbacks with their corresponding standard callback) |
1-2 |
Yes |
No |
|
5 |
CallbackName |
English (United States) |
Name used to identify this (new) callback (must be unique among all method's callback) |
6-64 |
No |
No |
|
6 |
ReturnType |
English (United States) |
VersaCloud type of return value (will be ignored for assynchronous callbacks) |
3-24 |
No |
No |
|
7 |
Protocol |
English (United States) |
Name of connection type to be used by VersaCloud to call into callback (e.g. OLEDB or WebService) |
3-64 |
No |
No |
|
8 |
ProtocolParameter1 |
English (United States) |
First part of strings needed with specified protocol (VersaCloud methods' parameters can be referenced by number as [%ID]) |
1-256 |
No |
No |
|
9 |
Synchronous |
English (United States) |
If True, callback is synchronous (VersaCloud waits for return value); if False, callback is assynchronous (upon call, a separate process will be spawned) |
4-5 |
No |
Yes |
|
10 |
ProtocolParameter2 |
English (United States) |
Second part of strings needed with specified protocol (VersaCloud methods' parameters can be referenced by number as [%ID]) |
1-256 |
No |
Yes |
|
11 |
ProtocolParameter3 |
English (United States) |
Third part of strings needed with specified protocol (VersaCloud methods' parameters can be referenced by number as [%ID]) |
1-256 |
No |
Yes |
|
12 |
ProtocolParameter4 |
English (United States) |
Fourth part of strings needed with specified protocol (VersaCloud methods' parameters can be referenced by number as [%ID]) |
1-256 |
No |
Yes |
|
13 |
ProtocolParameter5 |
English (United States) |
Fifth part of strings needed with specified protocol (VersaCloud methods' parameters can be referenced by number as [%ID]) |
1-256 |
No |
Yes |
|
14 |
Rollback |
English (United States) |
(default value is False) If True, instructs VersaCloud to call this callback only during automatic rollback; if False, callback is standard part of method's invocation |
4-5 |
No |
Yes |
|
1 |
Login |
Español (moderno) |
Protocolo de operación resultante de llamada exitosa a UserLoginAllow, identificando al usuario |
48-48 |
No |
No |
|
2 |
SolutionToken |
Español (moderno) |
Token máster de solución identificando la solución a la cual pertenece el método siendo modificado |
128-128 |
Yes |
No |
|
3 |
MethodName |
Español (moderno) |
Nombre del método que tendrá un callback añadido |
6-64 |
Yes |
No |
|
4 |
CallbackID |
Español (moderno) |
ID del callback (un entero positivo identificando este callback de forma única entre los callbacks del método - compartido por callbacks de rollback con su correspondiente callback normal) |
1-2 |
Yes |
No |
|
5 |
CallbackName |
Español (moderno) |
Nombre usado para identificar este (novo) callback (debe ser único entre todos los callbacks del método) |
6-64 |
No |
No |
|
6 |
ReturnType |
Español (moderno) |
Tipo VersaCloud del valor de retorno (será ignorado para callbacks asincrónicos) |
3-24 |
No |
No |
|
7 |
Protocol |
Español (moderno) |
Nombre del tipo de conexión a ser utilizada por VersaCloud para la llamada del callback (p.ej. OLEDB o WebService) |
3-64 |
No |
No |
|
8 |
ProtocolParameter1 |
Español (moderno) |
Primera parte de las secuencias de caracteres necesarias con el protocolo especificado (parámetros de los métodos VersaCloud pueden ser referenciados como [%ID]) |
1-256 |
No |
No |
|
9 |
Synchronous |
Español (moderno) |
Se True, callback es sincrónico (VersaCloud espera por el valor de retorno); se False, callback es asincrónico (cuando acionado, es ejecutado como un proceso independiente) |
4-5 |
No |
Yes |
|
10 |
ProtocolParameter2 |
Español (moderno) |
Segunda parte de las secuencias de caracteres necesarias con el protocolo especificado (parámetros de los métodos VersaCloud pueden ser referenciados como [%ID]) |
1-256 |
No |
Yes |
|
11 |
ProtocolParameter3 |
Español (moderno) |
Tercera parte de las secuencias de caracteres necesarias con el protocolo especificado (parámetros de los métodos VersaCloud pueden ser referenciados como [%ID]) |
1-256 |
No |
Yes |
|
12 |
ProtocolParameter4 |
Español (moderno) |
Cuarta parte de las secuencias de caracteres necesarias con el protocolo especificado (parámetros de los métodos VersaCloud pueden ser referenciados como [%ID]) |
1-256 |
No |
Yes |
|
13 |
ProtocolParameter5 |
Español (moderno) |
Quinta parte de las secuencias de caracteres necesarias con el protocolo especificado (parámetros de los métodos VersaCloud pueden ser referenciados como [%ID]) |
1-256 |
No |
Yes |
|
14 |
Rollback |
Español (moderno) |
(valor standard es Falso) Si True, especifica VersaCloud a llamar este callback solamente durante rollbacks automáticos; si False, callback es parte normal de la llamada del método |
4-5 |
No |
Yes |
|
1 |
Login |
Português (Brasil) |
Protocolo de operação resultante de chamada bem sucedida a UserLoginAllow, identificando o usuário |
48-48 |
No |
No |
|
2 |
SolutionToken |
Português (Brasil) |
Token master de solução identificando a solução à qual pertence o método sendo modificado |
128-128 |
Yes |
No |
|
3 |
MethodName |
Português (Brasil) |
Nome do método que terá um callback adicionado |
6-64 |
Yes |
No |
|
4 |
CallbackID |
Português (Brasil) |
ID do callback (um inteiro positivo identificando este callback de forma única entre os callbacks do método - compartilhado pelos callbacks de rollback com seu correspondente callback normal) |
1-2 |
Yes |
No |
|
5 |
CallbackName |
Português (Brasil) |
Nome usado para identificar este (novo) callback (deve ser único entre todos os callbacks do método) |
6-64 |
No |
No |
|
6 |
ReturnType |
Português (Brasil) |
Tipo VersaCloud do valor de retorno (será ignorado para callbacks assíncronos) |
3-24 |
No |
No |
|
7 |
Protocol |
Português (Brasil) |
Nome do tipo de conexão a ser usado por VersaCloud para a chamada do callback (p.ex. OLEDB ou WebService) |
3-64 |
No |
No |
|
8 |
ProtocolParameter1 |
Português (Brasil) |
Primeira parte das sequencias de caracteres necessárias com o protocolo especificado (parâmetros dos métodos VersaCloud podem ser referenciados como [%ID]) |
1-256 |
No |
No |
|
9 |
Synchronous |
Português (Brasil) |
Se True, callback é síncrono (VersaCloud aguarda pelo valor de retorno); se False, callback é assíncrono (quando acionado, é executado como um processo independente) |
4-5 |
No |
Yes |
|
10 |
ProtocolParameter2 |
Português (Brasil) |
Segunda parte das sequencias de caracteres necessárias com o protocolo especificado (parâmetros dos métodos VersaCloud podem ser referenciados como [%ID]) |
1-256 |
No |
Yes |
|
11 |
ProtocolParameter3 |
Português (Brasil) |
Terceira parte das sequencias de caracteres necessárias com o protocolo especificado (parâmetros dos métodos VersaCloud podem ser referenciados como [%ID]) |
1-256 |
No |
Yes |
|
12 |
ProtocolParameter4 |
Português (Brasil) |
Quarta parte das sequencias de caracteres necessárias com o protocolo especificado (parâmetros dos métodos VersaCloud podem ser referenciados como [%ID]) |
1-256 |
No |
Yes |
|
13 |
ProtocolParameter5 |
Português (Brasil) |
Quinta parte das sequencias de caracteres necessárias com o protocolo especificado (parâmetros dos métodos VersaCloud podem ser referenciados como [%ID]) |
1-256 |
No |
Yes |
|
14 |
Rollback |
Português (Brasil) |
(valor padrão é False) Se True, especifica a VersaCloud para chamar este callback somente durante rollbacks automáticos; se False, callback é parte normal da chamada do método |
4-5 |
No |
Yes |
Return Value
'CallbackAddAllow' returns a value of type operationHandle (minimum length of returned values is 48 characters characters, while maximum length of returned values is 48 characters characters).
Please note that all APIs returning values of types that allow for localized values (like e.g. boolean or country) always return the standard type values.
Specific Error Codes
If an error happens during the execution of any VersaCloud call, an errorcode is returned instead of the standard return value described above.
The following table lists errorcodes returned specifically by the 'CallbackAddAllow' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|---|---|
:@Err#Cbk0000011 |
English (United States) |
Value provided as new callback name is already in use with specified method |
:@Err#Cbk0000013 |
English (United States) |
Value provided as new callback ID is already in use with specified method |
:@Err#Cbk0000999 |
English (United States) |
Value provided as callback invocation protocol has not been implemented |
:@Err#Met0000011 |
English (United States) |
Value provided as method name is not part of specified Solution |
:@Err#Met0000911 |
English (United States) |
A method's definition cannot be modified while there are active transactions created as instance of this same method |
:@Err#Sol0000006 |
English (United States) |
Solution Token is not valid |
:@Err#Cbk0000011 |
Español (moderno) |
Valor informado como nuevo nombre de callback ya está en uso con el método especificado |
:@Err#Cbk0000013 |
Español (moderno) |
Valor informado como nuevo ID de callback ya está en uso con el método especificado |
:@Err#Cbk0000999 |
Español (moderno) |
Valor informado como protocolo de llamada callback no está implementado |
:@Err#Met0000011 |
Español (moderno) |
Valor informado como nombre de método no es parte de la solución indicada |
:@Err#Met0000911 |
Español (moderno) |
La definición de un método no puede ser cambiada mientras haya transacciones activas e instanciadas a partir del método en cuestión |
:@Err#Sol0000006 |
Español (moderno) |
Token de solución no es válido |
:@Err#Cbk0000011 |
Português (Brasil) |
Valor fornecido como novo nome de callback já está em uso com o método especificado |
:@Err#Cbk0000013 |
Português (Brasil) |
Valor fornecido como novo ID de callback já está em uso com o método especificado |
:@Err#Cbk0000999 |
Português (Brasil) |
Valor fornecido como protocolo de chamada de callback não está implementado |
:@Err#Met0000011 |
Português (Brasil) |
Valor informado como nome de método não é parte da solução especificada |
:@Err#Met0000911 |
Português (Brasil) |
A definição de um método não pode ser modificada enquanto houver transações ativas e instanciadas a partir do método em questão |
:@Err#Sol0000006 |
Português (Brasil) |
Token de solução não é válido |
US Patent Requested
