1 of 1

Error Handling

Server Errors

Client Errors

Error Objects

Error objects can be returned to you via LiveObjects, callbacks, or client error delegates. The possible error codes are listed in a public error code enum: each case is named after its error.

You can convert an Amity Exception into an Amity Error with the following:

All the errors returned by the iOS SDK come in form of an NSError with domain Amity.

For any specific errors that's handled in PagingData please visit the web page below to properly handle its errors https://developer.android.com/topic/libraries/architecture/paging/load-state#adapter

import { ErrorCode, CommunityRepository } from '@amityco/js-sdk'

const liveObject = CommunityRepository.communityForId('abc');
liveObject.on("dataUpdated", data => {
  // community is fetched
});
liveObject.on("dataError", err => {
  // failed to fetch the community 
  console.log(err.code == ErrorCode.BusinessError);
}

All the errors returned by the SDK come in form of an Error with domain ASC.

When an error is returned as a result of an action from your side (e.g. trying to join a channel), the action is considered completed and the SDK will not execute any additional logic.

Global ban error handling

A global ban error means that the user is banned from the system resulting in the inability to have a connection with the system. If the user already has a session, the session will be revoked and will be unable to create a new session.

var client: AmityClient?
client.clientErrorDelegate = self // set yourself as the delegate

...

// Implement this delegate method which gets called when error occurs
func didReceiveAsyncError(_ error: Error) {
        let error = error as NSError
        guard let amityError = AmityErrorCode(rawValue: error.code) else {
            assertionFailure("unknown error \(error.code), please report this code to Amity")
            return
        }
        
        if amityError == .globalBan {
            // Handle global ban event here
        }
    }

client = new ASCClient({ apiKey, apiEndpoint });

client.on('dataError', error => {
  if (error.code === ErrorCode.GlobalBanError) {
    // handle the case the user is globally banned
  }
});