csdk.v2.api.application

Interface IApplication

All Superinterfaces:

Serializable

public interface IApplication
extends Serializable

Interface que define os métodos a serem implementados por todas as aplicações CSDK. A classe principal da aplicação será construída via reflexão, que deve implementar esta interface e possuir um construtor público que receba como parâmetro uma instância de ICSDKEnvironment: public class MyApplication implements IApplication { public MyApplication(ICSDKInterface csdkInterface) { // código do construtor } // código do restante da classe } [ATENÇÃO] Os métodos dessa interface *não* devem ser chamados explicitamente pela aplicação, eles são de uso exclusivo do CSDK, para controle do ciclo de vida da aplicação.

Method Summary

Modifier and Type	Method and Description
boolean	canEndApplication() Determina se a aplicação pode ser encerrada.
void	onApplicationEnd() Encerra a execução da aplicação.
void	onApplicationStart() Inicializa a aplicação.
void	onAsyncMessageReceived(IMessage message, IMessageSender sender) Trata uma mensagem assíncrona recebida pela aplicação.
Object	onSyncMessageReceived(IMessage message, IMessageSender sender) Trata uma mensagem síncrona recebida pela aplicação.

Method Detail

onApplicationStart

void onApplicationStart()
                 throws ApplicationException

Inicializa a aplicação. [ATENÇÃO] Este método *não* deve ser chamado explicitamente pela aplicação, ele é de uso exclusivo do CSDK. Este método é chamado uma única vez pelo CSDK logo após o construtor da classe e logo antes da aplicação ser adicionada à lista de aplicações ativas no sistema.

Throws:

ApplicationException - Em caso de falha na inicialização da aplicação.

onApplicationEnd

void onApplicationEnd()
               throws ApplicationException

Encerra a execução da aplicação. [ATENÇÃO] Este método *não* deve ser chamado explicitamente pela aplicação, ele é de uso exclusivo do CSDK. Este método é chamado uma única vez pelo CSDK durante a finalização da aplicação, logo antes da aplicação ser removida da lista de aplicações ativas no sistema.

Throws:

ApplicationException - Em caso de falha na finalização da aplicação.

onAsyncMessageReceived

void onAsyncMessageReceived(IMessage message,
                            IMessageSender sender)

Trata uma mensagem assíncrona recebida pela aplicação. [ATENÇÃO] Este método *não* deve ser chamado explicitamente pela aplicação, ele é de uso exclusivo do CSDK. A aplicação poderá receber uma mensagem a qualquer momento de sua execução. O remetente da mensagem pode ser outra aplicação, representada pelo parâmetro sender ou o próprio ambiente, nesse caso o parâmetro sender vem nulo. Uma mesma aplicação pode receber diferentes tipos de mensagem, definidos por IMessage.getType(). O valor da mensagem é definido em IMessage.getValue().

Parameters:

message - a mensagem recebida.

sender - a aplicação que enviou a mensagem. (pode ser null - caso a mensagem tenha vindo do sistema, por exemplo)

onSyncMessageReceived

Object onSyncMessageReceived(IMessage message,
                             IMessageSender sender)

Trata uma mensagem síncrona recebida pela aplicação. [ATENÇÃO] Este método *não* deve ser chamado explicitamente pela aplicação, ele é de uso exclusivo do CSDK. A aplicação poderá receber uma mensagem a qualquer momento de sua execução. O remetente da mensagem pode ser outra aplicação, representada pelo parâmetro sender ou o próprio ambiente, nesse caso o parâmetro sender vem nulo. Uma mesma aplicação pode receber diferentes tipos de mensagem, definidos por IMessage.getType(). O valor da mensagem é definido em IMessage.getValue().

Parameters:

message - a mensagem recebida.

sender - a aplicação que enviou a mensagem. (pode ser null - caso a mensagem tenha vindo do sistema, por exemplo)

Returns:

resposta da mensagem.

canEndApplication

boolean canEndApplication()

Determina se a aplicação pode ser encerrada. [ATENÇÃO] Este método *não* deve ser chamado explicitamente pela aplicação, ele é de uso exclusivo do CSDK. Este método é chamado pelo CSDK quando o fechamento da aplicação é requisitado, dando chance da aplicação adiar o fechamento. No entanto, nem sempre é possível respeitar a recusa da aplicação em se fechar ou até sequer há chance deste método ser chamado antes da finalização. A aplicação deve estar pronta para lidar com todos esses cenários.

Returns:

true se a aplicação pode ser finalizada no momento ou false caso contrário.