This section details the callback and listener interfaces contained within the com.imimobile.connect.core.callbacks package.

• ICCreateThreadCallback
• ICFetchMessagesCallback
• ICFetchStreamsCallback - Removed in 2.7.0
• ICFetchThreadsCallback
• ICFetchTopicsCallback
• ICFileDownloadCallback
• ICFileUploadCallback
• ICMessagingListener
• ICPublishMessageCallback
• ICRegistrationCallback
• ICSecurityTokenExceptionListener
• ICSetMessageStatusCallback
• ICStartupCallback
• ICShutdownCallback
• ICSubscribeTopicCallback
• ICUnsubscribeTopicCallback
• ICUpdateProfileDataCallback
• ICUpdateThreadCallback
• ICUserAuthenticationCallback
• ICPublishEventCallback
• ICDeleteMessageCallback
• ICPushTokenListener

ICCreateThreadCallback

Used to receive the result of calls to the asynchronous ICMessaging.createThread method.

onCreateThreadComplete

Invoked when the ICMessaging.createThread method completes execution. If an error occurs the exception parameter will not be null.

  Syntax: void onCreateThreadComplete(ICThread thread, ICException exception);

  Parameters:

ICFetchMessagesCallback

Used to receive the result of calls to the asynchronous ICMessaging.fetchMessages method.

onFetchMessagesComplete

Invoked when the ICMessaging.fetchMessages completes execution. If an error occurs then the exception parameter will not be null.

  Syntax: onFetchMessagesComplete(ICMessage[] messages, boolean hasMoreData, ICException exception);

  Parameters:

ICFetchStreamsCallback

Removed since v2.7.0.

Used to receive the result of the asynchronous ICMessaging.fetchStreams method.

onFetchStreamsComplete

Invoked when calls to the ICMessaging.fetchStreams method completes execution. If an error occurs, then the exception parameter will not be null.

  Syntax: void onFetchStreamsComplete(ICStream[] streams, ICException exception);

  Parameters:

ICFetchThreadsCallback

Used to receive the result of the asynchronous ICMessaging.fetchThreads method.

onFetchThreadsComplete

Invoked when execution of ICMessaging.fetchThreads completes. If an error occurs then the exception parameter will not be null.

  Syntax: void onFetchThreadsComplete(ICThread[] threads, boolean hasMoreData, ICException exception);

  Parameters:

ICFetchTopicsCallback

Used to receive the result of the asynchronous ICMessaging.fetchTopics method.

onFetchTopicsComplete

Invoked when execution of ICMessaging.fetchTopics is complete. If an error occurs, then the exception parameter will be non-null.

  Syntax: void onFetchTopicsComplete(ICTopic[] topics, boolean hasMoreData, ICException exception)

  Parameters:

ICFileDownloadCallback

Used when downloading files with ICMediaFileManager to receive events related to progress and completion.

onFileDownloadComplete

Invoked when a download completes or has failed.

  Syntax: onFileDownloadComplete(URL url, File file, ICException exception)

  Parameters:

onFileDownloadProgress

Invoked to report the progress of a download operation.

  Syntax: onFileDownloadProgress(URL url, long bytesDownloaded, long bytesTotal)
 Parameters:

ICFileUploadCallback

Used when uploading files with ICMediaFileManager to receive events related to progress and completion.

onFileUploadComplete

Invoked when upload completes or has failed.

  Syntax: onFileUploadComplete(File file, String mediaId, ICException exception)

  Parameters:

onFileUploadProgress

Invoked to report the progress of a file upload operation.

  Syntax: onFileUploadProgress(File file, long bytesUploaded, long bytesTotal)

  Parameters:

ICMessagingListener

Interface for listening to events from the ICMessaging class.

onConnectionStatusChanged

Invoked when there is a change to the In-App Messaging connection status. If an error has occurred (status == .Error) the exception parameter will be non-null.

  Syntax: void onConnectionStatusChanged(ICConnectionStatus status, ICException exception) .

Parameter

onMessageReceived

Invoked when a new In-App Message is received from the imiconnect platform.

  Syntax: void onMessageReceived(ICMessage message).

Parameter

ICPublishMessageCallback

Used to receive the result of messages published via ICMessaging.publishMessage.

onPublishMessageComplete

Invoked to report the result of publishing an In-App Message. If an error occurs then the exception parameter will not be null.

  Syntax: void onPublishMessageComplete(ICMessage message, ICException exception)

  Parameters:

ICRegistrationCallback

Used to receive the result of calls to imiconnect.register.

onRegistrationComplete

Invoked to report the result of user registration. If an error occurs then the exception parameter will not be null.

The bundle parameter is reserved for future use to return registration-related information.

  Syntax: void onRegistrationComplete(Bundle bundle, ICException exception)

  Parameters:

ICSecurityTokenExceptionListener

Used for listening to Security Token exceptions that occur from API calls to the imiconnect Platform.

onException

Invoked whenever a Security Token exception occurs, the ICException object contains cause information.

  Syntax: void onException(ICException exception)

  Parameters:

ICSetMessageStatusCallback

Used to receive the result of message status updates for ICMessaging.setMessageAsRead and ICMessaging.setMessagesAsRead.

onSetMessageStatusComplete

Invoked to report the result of updating message statuses. If an error occurs then the exception parameter will be non-null.

  Syntax: void onSetMessageStatusComplete(String[] messageTransactionIds, ICException exception)

  Parameters:

ICStartupCallback

This interface contains a single method that is used to notify the caller when the SDK startup is complete.

If the startup failed the ICException parameter will be non-null and contains details of the failure.

public interface ICStartupCallback 

{ 

  void onStartupComplete(ICException e); 

}

ICShutdownCallback

This interface contains a single method that is used to notify the caller when the SDK shutdown is complete.

If the startup failed the ICException parameter will be non-null and contains details of the failure.

public interface ICShutdownCallback 

{ 

  void onShutdownComplete(final ICException e); 

}

onShutdownComplete

Invoked when the shutdown is complete.

  Syntax: void onShutdownComplete()

ICSubscribeTopicCallback

Used to receive the result of topic subscription operations made via ICMessaging.subscribeTopic.

onSubscribeTopicComplete

Invoked to report the result of the topic subscription. If the operation succeeds then the exception parameter will be null.

  Syntax: void onSubscribeTopicComplete(String topicId, ICException exception)

  Parameters:

ICUnsubscribeTopicCallback

Used to receive the result of calls to ICMessaging.unsubscribeTopic.

onUnsubscribeTopicComplete

Invoked to report the result of unsubscribing from a topic. If the operation succeeds, the exception parameter will be null.

  Syntax: void onUnsubscribeTopicComplete(String topicId, ICException exception)

  Parameters:

ICUpdateProfileDataCallback

Used to receive the result of profile update operations made via imiconnect.updateProfileData

onUpdateComplete

Invoked to report the result of profile update operations. If the operation succeeds the exception parameter will be null.

  Syntax: void onUpdateComplete(Bundle bundle, ICException exception)

  Parameters:

ICUpdateThreadCallback

Used to receive the result of calls to ICMessaging.updateThread and ICMessaging.closeThread

onUpdateThreadComplete

Invoked when the operation completes. If the call was successful the exception parameter will be null.

  Syntax: void onUpdateThreadComplete(ICThread thread, ICException exception);

  Parameters:

ICUserAuthenticationCallback

Captures events raised during the various stages of user authentication.

onPinGenerated

Invoked when a pin code has been successfully generated by the imiconnect platform, in response to a call of ICUserAuthentication.generatePin.

  Syntax: void onPinGenerated()

onPinValidated

Invoked when a pin code has been successfully validated. This may occur in response to ICUserAuthentication.validatePin or after automatic pin validation from an incoming SMS when the SDK is in listening mode.

  Syntax: void onPinValidated()

onPinReceived

Invoked when a pin has been received. This event is only raised when the SDK is listening for incoming SMS.

  Syntax: void onPinReceived()

onError

Invoked if any stage of the authentication process has failed.

  Syntax: void onError(ICException exception)

  Parameters:

ICPublishEventCallback

Used to receive the result of messages published via imiconnect.publishEvent.

onPublishEventComplete

Invoked to report the result of publishing events. If an error occurs then the exception parameter will not be null.

  Syntax: void onPublishEventComplete(Bundle bundle, ICException exception)

  Parameters:

ICDeleteMessageCallback

Used to receive the result of delele message operations made via ICMessaging.deleteMessage.

onDeleteMessageComplete

Invoked to report the result of delete message operations. If the operation succeeds the exception parameter will be null.

  Syntax: void onDeleteMessageComplete(String messageTransactionId, ICException exception)

  Parameters:

ICPushTokenListener

Used for listening to the updated push token.

onNewToken

Called when a new token for the default Firebase project is generated.

  Syntax: public void onNewToken(String token)

  Parameters:

ICRegenerateMediaURLCallback

Used to receive the result of calls to the asynchronous ICMediaFileManager. regenerateMediaURL method.

onRegenerateMediaURLComplete

Invoked when regenerate media URL is completed/failed.

Syntax:   void onRegenerateMediaURLComplete(URL url, ICException exception)