Public Member Functions
	BBDServiceError (int customErrorCode, string message, object details)

	BBDServiceError (BBDServiceErrorCode errorCode)

Properties
BBDServiceErrorCode	ErrorCode `[get]`
	Gets the error code. More...

string	Message `[get]`
	Gets the error message, if any. More...

int	CustomErrorCode `[get]`
	Gets the custom error code, if any. More...

object	Details `[get]`
	Gets the additional error details, if any. More...

Detailed Description

An error of this class may be encountered when the application is utilizing AppKinetics.

Errors of this class can originate within the AppKinetics system itself, or within service provider applications, which operate using AppKinetics.

An error of this class could be received as the results object when IBBDServiceClient.ReceiveClientMessage is invoked and an accepted request subsequently fails in the AppKinetics system or in the service provider.

An error of this class can be passed as the results object when an application that is a service provider calls the IBBDService.ReplyTo method.

Constructor & Destructor Documentation

◆ BBDServiceError() [1/2]

BBDXamarinForms.Common.Interfaces.AppKinetics.Errors.BBDServiceError.BBDServiceError	(	int	customErrorCode,
		string	message,
		object	details
	)

inline

Initializes a new instance of the BBDServiceError class.

Call this constructor to create an instance with a custom error code.

The returned object is suitable for use with the IBBDService.ReplyTo method.

Parameters

customErrorCode	Error code to set. Details of what custom codes can be returned in a service response should be documented in the service definition.
message	String containing an error message, or null not to include an error message. If there is a message, then the text should be suitable for display to an end user, at least for diagnostic purposes.
details	Object containing the additional error details, or null. The service definition should specify what additional error details, if any, are sent with which custom error codes.

◆ BBDServiceError() [2/2]

BBDXamarinForms.Common.Interfaces.AppKinetics.Errors.BBDServiceError.BBDServiceError ( BBDServiceErrorCode errorCode )

inline

Initializes a new instance of the BBDServiceError class.

Call this constructor to create an instance with a custom error code.

The returned object is suitable for use with the IBBDService.ReplyTo method.

Parameters

errorCode Error code to set. See BBDServiceErrorCode enum for details of when each code must be used.

Property Documentation

◆ CustomErrorCode

int BBDXamarinForms.Common.Interfaces.AppKinetics.Errors.BBDServiceError.CustomErrorCode

get

Gets the custom error code, if any.

The custom error code if there was one, or zero otherwise.

◆ Details

object BBDXamarinForms.Common.Interfaces.AppKinetics.Errors.BBDServiceError.Details

get

Gets the additional error details, if any.

Object containing the additional error details, or null if there are no additional details.

◆ ErrorCode

BBDServiceErrorCode BBDXamarinForms.Common.Interfaces.AppKinetics.Errors.BBDServiceError.ErrorCode

get

Gets the error code.

A system error code, or BBDServicesErrorCustom if a custom error occurred.

◆ Message

string BBDXamarinForms.Common.Interfaces.AppKinetics.Errors.BBDServiceError.Message

get

Gets the error message, if any.

String containing the error message, or null if there was no message.

Public Member Functions

Properties